openapi: 3.0.3
info:
title: NetBox REST authentication-check extras API
version: 4.5.9 (4.5)
license:
name: Apache v2 License
servers:
- url: ''
description: NetBox
tags:
- name: extras
paths:
/api/extras/bookmarks/:
get:
operationId: extras_bookmarks_list
description: Get a list of bookmark objects.
parameters:
- in: query
name: created
schema:
type: string
format: date-time
- in: query
name: id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__empty
schema:
type: boolean
- in: query
name: id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: object_id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_id__empty
schema:
type: boolean
- in: query
name: object_id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_type
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type_id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_type_id__empty
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_type_id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_type_id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_type_id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_type_id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_type_id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- in: query
name: user
schema:
type: array
items:
type: string
description: User (name)
explode: true
style: form
- in: query
name: user__n
schema:
type: array
items:
type: string
description: User (name)
explode: true
style: form
- in: query
name: user_id
schema:
type: array
items:
type: integer
description: User (ID)
explode: true
style: form
- in: query
name: user_id__n
schema:
type: array
items:
type: integer
description: User (ID)
explode: true
style: form
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedBookmarkList'
description: ''
post:
operationId: extras_bookmarks_create
description: Post a list of bookmark objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/BookmarkRequest'
- type: array
items:
$ref: '#/components/schemas/BookmarkRequest'
multipart/form-data:
schema:
oneOf:
- $ref: '#/components/schemas/BookmarkRequest'
- type: array
items:
$ref: '#/components/schemas/BookmarkRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Bookmark'
description: ''
put:
operationId: extras_bookmarks_bulk_update
description: Put a list of bookmark objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BookmarkRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/BookmarkRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Bookmark'
description: ''
patch:
operationId: extras_bookmarks_bulk_partial_update
description: Patch a list of bookmark objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BookmarkRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/BookmarkRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Bookmark'
description: ''
delete:
operationId: extras_bookmarks_bulk_destroy
description: Delete a list of bookmark objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BookmarkRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/BookmarkRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/bookmarks/{id}/:
get:
operationId: extras_bookmarks_retrieve
description: Get a bookmark object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this bookmark.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Bookmark'
description: ''
put:
operationId: extras_bookmarks_update
description: Put a bookmark object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this bookmark.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BookmarkRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/BookmarkRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Bookmark'
description: ''
patch:
operationId: extras_bookmarks_partial_update
description: Patch a bookmark object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this bookmark.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedBookmarkRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedBookmarkRequest'
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Bookmark'
description: ''
delete:
operationId: extras_bookmarks_destroy
description: Delete a bookmark object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this bookmark.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/config-context-profiles/:
get:
operationId: extras_config_context_profiles_list
description: Get a list of config context profile objects.
parameters:
- in: query
name: auto_sync_enabled
schema:
type: boolean
- in: query
name: created
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created_by_request
schema:
type: string
format: uuid
- in: query
name: data_file_id
schema:
type: array
items:
type: integer
nullable: true
description: Data file (ID)
explode: true
style: form
- in: query
name: data_file_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Data file (ID)
explode: true
style: form
- in: query
name: data_source_id
schema:
type: array
items:
type: integer
nullable: true
description: Data source (ID)
explode: true
style: form
- in: query
name: data_source_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Data source (ID)
explode: true
style: form
- in: query
name: data_synced
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: data_synced__empty
schema:
type: boolean
- in: query
name: data_synced__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: data_synced__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: data_synced__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: data_synced__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: data_synced__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: description
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__empty
schema:
type: boolean
- in: query
name: description__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__empty
schema:
type: boolean
- in: query
name: id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: last_updated
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: modified_by_request
schema:
type: string
format: uuid
- in: query
name: name
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__empty
schema:
type: boolean
- in: query
name: name__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__regex
schema:
type: array
items:
type: string
explode: true
style: form
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- in: query
name: owner
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner__n
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner_group
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group__n
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group_id
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_group_id__n
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_id
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: owner_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: q
schema:
type: string
description: Search
- in: query
name: tag
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: tag__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: tag_id
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: tag_id__n
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: updated_by_request
schema:
type: string
format: uuid
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedConfigContextProfileList'
description: ''
post:
operationId: extras_config_context_profiles_create
description: Post a list of config context profile objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ConfigContextProfileRequest'
- type: array
items:
$ref: '#/components/schemas/ConfigContextProfileRequest'
multipart/form-data:
schema:
oneOf:
- $ref: '#/components/schemas/ConfigContextProfileRequest'
- type: array
items:
$ref: '#/components/schemas/ConfigContextProfileRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigContextProfile'
description: ''
put:
operationId: extras_config_context_profiles_bulk_update
description: Put a list of config context profile objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigContextProfileRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigContextProfileRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigContextProfile'
description: ''
patch:
operationId: extras_config_context_profiles_bulk_partial_update
description: Patch a list of config context profile objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigContextProfileRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigContextProfileRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigContextProfile'
description: ''
delete:
operationId: extras_config_context_profiles_bulk_destroy
description: Delete a list of config context profile objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigContextProfileRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigContextProfileRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/config-context-profiles/{id}/:
get:
operationId: extras_config_context_profiles_retrieve
description: Get a config context profile object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this config context profile.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigContextProfile'
description: ''
put:
operationId: extras_config_context_profiles_update
description: Put a config context profile object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this config context profile.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigContextProfileRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ConfigContextProfileRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigContextProfile'
description: ''
patch:
operationId: extras_config_context_profiles_partial_update
description: Patch a config context profile object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this config context profile.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedConfigContextProfileRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedConfigContextProfileRequest'
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigContextProfile'
description: ''
delete:
operationId: extras_config_context_profiles_destroy
description: Delete a config context profile object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this config context profile.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/config-context-profiles/{id}/sync/:
post:
operationId: extras_config_context_profiles_sync_create
description: Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any).
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this config context profile.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigContextProfileRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ConfigContextProfileRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigContextProfile'
description: ''
/api/extras/config-contexts/:
get:
operationId: extras_config_contexts_list
description: Get a list of config context objects.
parameters:
- in: query
name: auto_sync_enabled
schema:
type: boolean
- in: query
name: cluster_group
schema:
type: array
items:
type: string
description: Cluster group (slug)
explode: true
style: form
- in: query
name: cluster_group__n
schema:
type: array
items:
type: string
description: Cluster group (slug)
explode: true
style: form
- in: query
name: cluster_group_id
schema:
type: array
items:
type: integer
description: Cluster group
explode: true
style: form
- in: query
name: cluster_group_id__n
schema:
type: array
items:
type: integer
description: Cluster group
explode: true
style: form
- in: query
name: cluster_id
schema:
type: array
items:
type: integer
description: Cluster
explode: true
style: form
- in: query
name: cluster_id__n
schema:
type: array
items:
type: integer
description: Cluster
explode: true
style: form
- in: query
name: cluster_type
schema:
type: array
items:
type: string
description: Cluster type (slug)
explode: true
style: form
- in: query
name: cluster_type__n
schema:
type: array
items:
type: string
description: Cluster type (slug)
explode: true
style: form
- in: query
name: cluster_type_id
schema:
type: array
items:
type: integer
description: Cluster type
explode: true
style: form
- in: query
name: cluster_type_id__n
schema:
type: array
items:
type: integer
description: Cluster type
explode: true
style: form
- in: query
name: created
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created_by_request
schema:
type: string
format: uuid
- in: query
name: data_file_id
schema:
type: array
items:
type: integer
nullable: true
description: Data file (ID)
explode: true
style: form
- in: query
name: data_file_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Data file (ID)
explode: true
style: form
- in: query
name: data_source_id
schema:
type: array
items:
type: integer
nullable: true
description: Data source (ID)
explode: true
style: form
- in: query
name: data_source_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Data source (ID)
explode: true
style: form
- in: query
name: data_synced
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: data_synced__empty
schema:
type: boolean
- in: query
name: data_synced__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: data_synced__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: data_synced__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: data_synced__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: data_synced__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: description
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__empty
schema:
type: boolean
- in: query
name: description__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: device_role
schema:
type: array
items:
type: string
description: Role (slug)
explode: true
style: form
- in: query
name: device_role__n
schema:
type: array
items:
type: string
description: Role (slug)
explode: true
style: form
- in: query
name: device_role_id
schema:
type: array
items:
type: integer
description: Role
explode: true
style: form
- in: query
name: device_role_id__n
schema:
type: array
items:
type: integer
description: Role
explode: true
style: form
- in: query
name: device_type_id
schema:
type: array
items:
type: integer
description: Device type
explode: true
style: form
- in: query
name: device_type_id__n
schema:
type: array
items:
type: integer
description: Device type
explode: true
style: form
- in: query
name: id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__empty
schema:
type: boolean
- in: query
name: id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: is_active
schema:
type: boolean
- in: query
name: last_updated
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: location
schema:
type: array
items:
type: string
description: Location (slug)
explode: true
style: form
- in: query
name: location__n
schema:
type: array
items:
type: string
description: Location (slug)
explode: true
style: form
- in: query
name: location_id
schema:
type: array
items:
type: integer
description: Location
explode: true
style: form
- in: query
name: location_id__n
schema:
type: array
items:
type: integer
description: Location
explode: true
style: form
- in: query
name: modified_by_request
schema:
type: string
format: uuid
- in: query
name: name
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__empty
schema:
type: boolean
- in: query
name: name__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__regex
schema:
type: array
items:
type: string
explode: true
style: form
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- in: query
name: owner
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner__n
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner_group
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group__n
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group_id
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_group_id__n
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_id
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: owner_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: platform
schema:
type: array
items:
type: string
description: Platform (slug)
explode: true
style: form
- in: query
name: platform__n
schema:
type: array
items:
type: string
description: Platform (slug)
explode: true
style: form
- in: query
name: platform_id
schema:
type: array
items:
type: integer
description: Platform
explode: true
style: form
- in: query
name: platform_id__n
schema:
type: array
items:
type: integer
description: Platform
explode: true
style: form
- in: query
name: profile
schema:
type: array
items:
type: string
description: Profile (name)
explode: true
style: form
- in: query
name: profile__n
schema:
type: array
items:
type: string
description: Profile (name)
explode: true
style: form
- in: query
name: profile_id
schema:
type: array
items:
type: integer
nullable: true
description: Profile (ID)
explode: true
style: form
- in: query
name: profile_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Profile (ID)
explode: true
style: form
- in: query
name: q
schema:
type: string
description: Search
- in: query
name: region
schema:
type: array
items:
type: string
description: Region (slug)
explode: true
style: form
- in: query
name: region__n
schema:
type: array
items:
type: string
description: Region (slug)
explode: true
style: form
- in: query
name: region_id
schema:
type: array
items:
type: integer
description: Region
explode: true
style: form
- in: query
name: region_id__n
schema:
type: array
items:
type: integer
description: Region
explode: true
style: form
- in: query
name: site
schema:
type: array
items:
type: string
description: Site (slug)
explode: true
style: form
- in: query
name: site__n
schema:
type: array
items:
type: string
description: Site (slug)
explode: true
style: form
- in: query
name: site_group
schema:
type: array
items:
type: string
description: Site group (slug)
explode: true
style: form
- in: query
name: site_group__n
schema:
type: array
items:
type: string
description: Site group (slug)
explode: true
style: form
- in: query
name: site_group_id
schema:
type: array
items:
type: integer
description: Site group
explode: true
style: form
- in: query
name: site_group_id__n
schema:
type: array
items:
type: integer
description: Site group
explode: true
style: form
- in: query
name: site_id
schema:
type: array
items:
type: integer
description: Site
explode: true
style: form
- in: query
name: site_id__n
schema:
type: array
items:
type: integer
description: Site
explode: true
style: form
- in: query
name: tag
schema:
type: array
items:
type: string
description: Tag (slug)
explode: true
style: form
- in: query
name: tag__n
schema:
type: array
items:
type: string
description: Tag (slug)
explode: true
style: form
- in: query
name: tag_id
schema:
type: array
items:
type: integer
description: Tag
explode: true
style: form
- in: query
name: tag_id__n
schema:
type: array
items:
type: integer
description: Tag
explode: true
style: form
- in: query
name: tenant
schema:
type: array
items:
type: string
description: Tenant (slug)
explode: true
style: form
- in: query
name: tenant__n
schema:
type: array
items:
type: string
description: Tenant (slug)
explode: true
style: form
- in: query
name: tenant_group
schema:
type: array
items:
type: string
description: Tenant group (slug)
explode: true
style: form
- in: query
name: tenant_group__n
schema:
type: array
items:
type: string
description: Tenant group (slug)
explode: true
style: form
- in: query
name: tenant_group_id
schema:
type: array
items:
type: integer
description: Tenant group
explode: true
style: form
- in: query
name: tenant_group_id__n
schema:
type: array
items:
type: integer
description: Tenant group
explode: true
style: form
- in: query
name: tenant_id
schema:
type: array
items:
type: integer
description: Tenant
explode: true
style: form
- in: query
name: tenant_id__n
schema:
type: array
items:
type: integer
description: Tenant
explode: true
style: form
- in: query
name: updated_by_request
schema:
type: string
format: uuid
- in: query
name: weight
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__empty
schema:
type: boolean
- in: query
name: weight__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedConfigContextList'
description: ''
post:
operationId: extras_config_contexts_create
description: Post a list of config context objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ConfigContextRequest'
- type: array
items:
$ref: '#/components/schemas/ConfigContextRequest'
multipart/form-data:
schema:
oneOf:
- $ref: '#/components/schemas/ConfigContextRequest'
- type: array
items:
$ref: '#/components/schemas/ConfigContextRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigContext'
description: ''
put:
operationId: extras_config_contexts_bulk_update
description: Put a list of config context objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigContextRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigContextRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigContext'
description: ''
patch:
operationId: extras_config_contexts_bulk_partial_update
description: Patch a list of config context objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigContextRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigContextRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigContext'
description: ''
delete:
operationId: extras_config_contexts_bulk_destroy
description: Delete a list of config context objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigContextRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigContextRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/config-contexts/{id}/:
get:
operationId: extras_config_contexts_retrieve
description: Get a config context object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this config context.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigContext'
description: ''
put:
operationId: extras_config_contexts_update
description: Put a config context object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this config context.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigContextRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ConfigContextRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigContext'
description: ''
patch:
operationId: extras_config_contexts_partial_update
description: Patch a config context object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this config context.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedConfigContextRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedConfigContextRequest'
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigContext'
description: ''
delete:
operationId: extras_config_contexts_destroy
description: Delete a config context object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this config context.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/config-contexts/{id}/sync/:
post:
operationId: extras_config_contexts_sync_create
description: Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any).
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this config context.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigContextRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ConfigContextRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigContext'
description: ''
/api/extras/config-templates/:
get:
operationId: extras_config_templates_list
description: Get a list of config template objects.
parameters:
- in: query
name: as_attachment
schema:
type: boolean
- in: query
name: auto_sync_enabled
schema:
type: boolean
- in: query
name: created
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created_by_request
schema:
type: string
format: uuid
- in: query
name: data_file_id
schema:
type: array
items:
type: integer
nullable: true
description: Data file (ID)
explode: true
style: form
- in: query
name: data_file_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Data file (ID)
explode: true
style: form
- in: query
name: data_source_id
schema:
type: array
items:
type: integer
nullable: true
description: Data source (ID)
explode: true
style: form
- in: query
name: data_source_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Data source (ID)
explode: true
style: form
- in: query
name: data_synced
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: data_synced__empty
schema:
type: boolean
- in: query
name: data_synced__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: data_synced__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: data_synced__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: data_synced__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: data_synced__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: description
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__empty
schema:
type: boolean
- in: query
name: description__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension__empty
schema:
type: boolean
- in: query
name: file_extension__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name__empty
schema:
type: boolean
- in: query
name: file_name__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__empty
schema:
type: boolean
- in: query
name: id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: last_updated
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: mime_type
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: mime_type__empty
schema:
type: boolean
- in: query
name: mime_type__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: mime_type__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: mime_type__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: mime_type__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: mime_type__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: mime_type__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: mime_type__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: mime_type__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: mime_type__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: mime_type__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: mime_type__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: modified_by_request
schema:
type: string
format: uuid
- in: query
name: name
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__empty
schema:
type: boolean
- in: query
name: name__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__regex
schema:
type: array
items:
type: string
explode: true
style: form
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- in: query
name: owner
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner__n
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner_group
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group__n
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group_id
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_group_id__n
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_id
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: owner_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: q
schema:
type: string
description: Search
- in: query
name: tag
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: tag__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: tag_id
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: tag_id__n
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: updated_by_request
schema:
type: string
format: uuid
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedConfigTemplateList'
description: ''
post:
operationId: extras_config_templates_create
description: Post a list of config template objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ConfigTemplateRequest'
- type: array
items:
$ref: '#/components/schemas/ConfigTemplateRequest'
multipart/form-data:
schema:
oneOf:
- $ref: '#/components/schemas/ConfigTemplateRequest'
- type: array
items:
$ref: '#/components/schemas/ConfigTemplateRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigTemplate'
description: ''
put:
operationId: extras_config_templates_bulk_update
description: Put a list of config template objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigTemplateRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigTemplateRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigTemplate'
description: ''
patch:
operationId: extras_config_templates_bulk_partial_update
description: Patch a list of config template objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigTemplateRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigTemplateRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigTemplate'
description: ''
delete:
operationId: extras_config_templates_bulk_destroy
description: Delete a list of config template objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigTemplateRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigTemplateRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/config-templates/{id}/:
get:
operationId: extras_config_templates_retrieve
description: Get a config template object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this config template.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigTemplate'
description: ''
put:
operationId: extras_config_templates_update
description: Put a config template object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this config template.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigTemplateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ConfigTemplateRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigTemplate'
description: ''
patch:
operationId: extras_config_templates_partial_update
description: Patch a config template object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this config template.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedConfigTemplateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedConfigTemplateRequest'
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigTemplate'
description: ''
delete:
operationId: extras_config_templates_destroy
description: Delete a config template object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this config template.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/config-templates/{id}/render/:
post:
operationId: extras_config_templates_render_create
description: 'Render a ConfigTemplate using the context data provided (if any). If the client requests "text/plain" data,
return the raw rendered content, rather than serialized JSON.'
parameters:
- in: query
name: format
schema:
type: string
enum:
- json
- txt
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this config template.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigTemplateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ConfigTemplateRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigTemplate'
text/plain:
schema:
$ref: '#/components/schemas/ConfigTemplate'
description: ''
/api/extras/config-templates/{id}/sync/:
post:
operationId: extras_config_templates_sync_create
description: Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any).
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this config template.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigTemplateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ConfigTemplateRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigTemplate'
description: ''
/api/extras/custom-field-choice-sets/:
get:
operationId: extras_custom_field_choice_sets_list
description: Get a list of custom field choice set objects.
parameters:
- in: query
name: base_choices
schema:
type: string
x-spec-enum-id: cf0efb5195f85007
nullable: true
enum:
- IATA
- ISO_3166
- UN_LOCODE
- 'null'
description: 'Base set of predefined choices (optional)
* `IATA` - IATA (Airport codes)
* `ISO_3166` - ISO 3166 (Country codes)
* `UN_LOCODE` - UN/LOCODE (Location codes)'
- in: query
name: base_choices__empty
schema:
type: boolean
- in: query
name: base_choices__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: base_choices__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: base_choices__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: base_choices__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: base_choices__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: base_choices__n
schema:
type: string
x-spec-enum-id: cf0efb5195f85007
nullable: true
enum:
- IATA
- ISO_3166
- UN_LOCODE
- 'null'
description: 'Base set of predefined choices (optional)
* `IATA` - IATA (Airport codes)
* `ISO_3166` - ISO 3166 (Country codes)
* `UN_LOCODE` - UN/LOCODE (Location codes)'
- in: query
name: base_choices__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: base_choices__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: base_choices__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: base_choices__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: base_choices__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: choice
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: created
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created_by_request
schema:
type: string
format: uuid
- in: query
name: description
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__empty
schema:
type: boolean
- in: query
name: description__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__empty
schema:
type: boolean
- in: query
name: id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: last_updated
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: modified_by_request
schema:
type: string
format: uuid
- in: query
name: name
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__empty
schema:
type: boolean
- in: query
name: name__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__regex
schema:
type: array
items:
type: string
explode: true
style: form
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: query
name: order_alphabetically
schema:
type: boolean
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- in: query
name: owner
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner__n
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner_group
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group__n
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group_id
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_group_id__n
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_id
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: owner_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: q
schema:
type: string
description: Search
- in: query
name: updated_by_request
schema:
type: string
format: uuid
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedCustomFieldChoiceSetList'
description: ''
post:
operationId: extras_custom_field_choice_sets_create
description: Post a list of custom field choice set objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/WritableCustomFieldChoiceSetRequest'
- type: array
items:
$ref: '#/components/schemas/WritableCustomFieldChoiceSetRequest'
multipart/form-data:
schema:
oneOf:
- $ref: '#/components/schemas/WritableCustomFieldChoiceSetRequest'
- type: array
items:
$ref: '#/components/schemas/WritableCustomFieldChoiceSetRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldChoiceSet'
description: ''
put:
operationId: extras_custom_field_choice_sets_bulk_update
description: Put a list of custom field choice set objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomFieldChoiceSetRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/CustomFieldChoiceSetRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomFieldChoiceSet'
description: ''
patch:
operationId: extras_custom_field_choice_sets_bulk_partial_update
description: Patch a list of custom field choice set objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomFieldChoiceSetRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/CustomFieldChoiceSetRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomFieldChoiceSet'
description: ''
delete:
operationId: extras_custom_field_choice_sets_bulk_destroy
description: Delete a list of custom field choice set objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomFieldChoiceSetRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/CustomFieldChoiceSetRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/custom-field-choice-sets/{id}/:
get:
operationId: extras_custom_field_choice_sets_retrieve
description: Get a custom field choice set object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this custom field choice set.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldChoiceSet'
description: ''
put:
operationId: extras_custom_field_choice_sets_update
description: Put a custom field choice set object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this custom field choice set.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCustomFieldChoiceSetRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/WritableCustomFieldChoiceSetRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldChoiceSet'
description: ''
patch:
operationId: extras_custom_field_choice_sets_partial_update
description: Patch a custom field choice set object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this custom field choice set.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedWritableCustomFieldChoiceSetRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedWritableCustomFieldChoiceSetRequest'
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldChoiceSet'
description: ''
delete:
operationId: extras_custom_field_choice_sets_destroy
description: Delete a custom field choice set object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this custom field choice set.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/custom-field-choice-sets/{id}/choices/:
get:
operationId: extras_custom_field_choice_sets_choices_retrieve
description: Provides an endpoint to iterate through each choice in a set.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this custom field choice set.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldChoiceSet'
description: ''
/api/extras/custom-fields/:
get:
operationId: extras_custom_fields_list
description: Get a list of custom field objects.
parameters:
- in: query
name: choice_set
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: choice_set__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: choice_set_id
schema:
type: array
items:
type: integer
nullable: true
explode: true
style: form
- in: query
name: choice_set_id__n
schema:
type: array
items:
type: integer
nullable: true
explode: true
style: form
- in: query
name: created
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created_by_request
schema:
type: string
format: uuid
- in: query
name: description
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__empty
schema:
type: boolean
- in: query
name: description__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: filter_logic
schema:
type: string
x-spec-enum-id: d168820c798ae45a
enum:
- disabled
- exact
- loose
- 'null'
description: 'Loose matches any instance of a given string; exact matches the entire field.
* `disabled` - Disabled
* `loose` - Loose
* `exact` - Exact'
- in: query
name: filter_logic__empty
schema:
type: boolean
- in: query
name: filter_logic__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: filter_logic__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: filter_logic__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: filter_logic__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: filter_logic__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: filter_logic__n
schema:
type: string
x-spec-enum-id: d168820c798ae45a
enum:
- disabled
- exact
- loose
- 'null'
description: 'Loose matches any instance of a given string; exact matches the entire field.
* `disabled` - Disabled
* `loose` - Loose
* `exact` - Exact'
- in: query
name: filter_logic__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: filter_logic__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: filter_logic__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: filter_logic__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: filter_logic__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name__empty
schema:
type: boolean
- in: query
name: group_name__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__empty
schema:
type: boolean
- in: query
name: id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: is_cloneable
schema:
type: boolean
- in: query
name: label
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: label__empty
schema:
type: boolean
- in: query
name: label__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: label__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: label__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: label__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: label__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: label__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: label__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: label__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: label__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: label__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: label__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: last_updated
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: modified_by_request
schema:
type: string
format: uuid
- in: query
name: name
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__empty
schema:
type: boolean
- in: query
name: name__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type_id
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: object_type_id__n
schema:
type: array
items:
type: integer
explode: true
style: form
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- in: query
name: owner
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner__n
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner_group
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group__n
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group_id
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_group_id__n
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_id
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: owner_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: q
schema:
type: string
description: Search
- in: query
name: related_object_type
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: related_object_type__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: related_object_type_id
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: related_object_type_id__n
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: required
schema:
type: boolean
- in: query
name: search_weight
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: search_weight__empty
schema:
type: boolean
- in: query
name: search_weight__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: search_weight__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: search_weight__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: search_weight__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: search_weight__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: type
schema:
type: array
items:
type: string
x-spec-enum-id: 47c52a3d983e924c
description: The type of data this custom field holds
explode: true
style: form
- in: query
name: type__empty
schema:
type: boolean
- in: query
name: type__ic
schema:
type: array
items:
type: string
x-spec-enum-id: 47c52a3d983e924c
description: The type of data this custom field holds
explode: true
style: form
- in: query
name: type__ie
schema:
type: array
items:
type: string
x-spec-enum-id: 47c52a3d983e924c
description: The type of data this custom field holds
explode: true
style: form
- in: query
name: type__iew
schema:
type: array
items:
type: string
x-spec-enum-id: 47c52a3d983e924c
description: The type of data this custom field holds
explode: true
style: form
- in: query
name: type__iregex
schema:
type: array
items:
type: string
x-spec-enum-id: 47c52a3d983e924c
description: The type of data this custom field holds
explode: true
style: form
- in: query
name: type__isw
schema:
type: array
items:
type: string
x-spec-enum-id: 47c52a3d983e924c
description: The type of data this custom field holds
explode: true
style: form
- in: query
name: type__n
schema:
type: array
items:
type: string
x-spec-enum-id: 47c52a3d983e924c
description: The type of data this custom field holds
explode: true
style: form
- in: query
name: type__nic
schema:
type: array
items:
type: string
x-spec-enum-id: 47c52a3d983e924c
description: The type of data this custom field holds
explode: true
style: form
- in: query
name: type__nie
schema:
type: array
items:
type: string
x-spec-enum-id: 47c52a3d983e924c
description: The type of data this custom field holds
explode: true
style: form
- in: query
name: type__niew
schema:
type: array
items:
type: string
x-spec-enum-id: 47c52a3d983e924c
description: The type of data this custom field holds
explode: true
style: form
- in: query
name: type__nisw
schema:
type: array
items:
type: string
x-spec-enum-id: 47c52a3d983e924c
description: The type of data this custom field holds
explode: true
style: form
- in: query
name: type__regex
schema:
type: array
items:
type: string
x-spec-enum-id: 47c52a3d983e924c
description: The type of data this custom field holds
explode: true
style: form
- in: query
name: ui_editable
schema:
type: string
x-spec-enum-id: 336f52760e62022f
enum:
- hidden
- 'no'
- 'null'
- 'yes'
description: 'Specifies whether the custom field value can be edited in the UI
* `yes` - Yes
* `no` - No
* `hidden` - Hidden'
- in: query
name: ui_editable__empty
schema:
type: boolean
- in: query
name: ui_editable__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ui_editable__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ui_editable__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ui_editable__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ui_editable__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ui_editable__n
schema:
type: string
x-spec-enum-id: 336f52760e62022f
enum:
- hidden
- 'no'
- 'null'
- 'yes'
description: 'Specifies whether the custom field value can be edited in the UI
* `yes` - Yes
* `no` - No
* `hidden` - Hidden'
- in: query
name: ui_editable__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ui_editable__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ui_editable__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ui_editable__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ui_editable__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ui_visible
schema:
type: string
x-spec-enum-id: f32800c399b927b6
enum:
- always
- hidden
- if-set
- 'null'
description: 'Specifies whether the custom field is displayed in the UI
* `always` - Always
* `if-set` - If set
* `hidden` - Hidden'
- in: query
name: ui_visible__empty
schema:
type: boolean
- in: query
name: ui_visible__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ui_visible__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ui_visible__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ui_visible__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ui_visible__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ui_visible__n
schema:
type: string
x-spec-enum-id: f32800c399b927b6
enum:
- always
- hidden
- if-set
- 'null'
description: 'Specifies whether the custom field is displayed in the UI
* `always` - Always
* `if-set` - If set
* `hidden` - Hidden'
- in: query
name: ui_visible__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ui_visible__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ui_visible__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ui_visible__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ui_visible__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: unique
schema:
type: boolean
- in: query
name: updated_by_request
schema:
type: string
format: uuid
- in: query
name: validation_maximum
schema:
type: array
items:
type: number
format: double
explode: true
style: form
- in: query
name: validation_maximum__empty
schema:
type: boolean
- in: query
name: validation_maximum__gt
schema:
type: array
items:
type: number
format: double
explode: true
style: form
- in: query
name: validation_maximum__gte
schema:
type: array
items:
type: number
format: double
explode: true
style: form
- in: query
name: validation_maximum__lt
schema:
type: array
items:
type: number
format: double
explode: true
style: form
- in: query
name: validation_maximum__lte
schema:
type: array
items:
type: number
format: double
explode: true
style: form
- in: query
name: validation_maximum__n
schema:
type: array
items:
type: number
format: double
explode: true
style: form
- in: query
name: validation_minimum
schema:
type: array
items:
type: number
format: double
explode: true
style: form
- in: query
name: validation_minimum__empty
schema:
type: boolean
- in: query
name: validation_minimum__gt
schema:
type: array
items:
type: number
format: double
explode: true
style: form
- in: query
name: validation_minimum__gte
schema:
type: array
items:
type: number
format: double
explode: true
style: form
- in: query
name: validation_minimum__lt
schema:
type: array
items:
type: number
format: double
explode: true
style: form
- in: query
name: validation_minimum__lte
schema:
type: array
items:
type: number
format: double
explode: true
style: form
- in: query
name: validation_minimum__n
schema:
type: array
items:
type: number
format: double
explode: true
style: form
- in: query
name: validation_regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: validation_regex__empty
schema:
type: boolean
- in: query
name: validation_regex__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: validation_regex__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: validation_regex__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: validation_regex__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: validation_regex__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: validation_regex__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: validation_regex__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: validation_regex__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: validation_regex__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: validation_regex__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: validation_regex__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: weight
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__empty
schema:
type: boolean
- in: query
name: weight__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedCustomFieldList'
description: ''
post:
operationId: extras_custom_fields_create
description: Post a list of custom field objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/WritableCustomFieldRequest'
- type: array
items:
$ref: '#/components/schemas/WritableCustomFieldRequest'
multipart/form-data:
schema:
oneOf:
- $ref: '#/components/schemas/WritableCustomFieldRequest'
- type: array
items:
$ref: '#/components/schemas/WritableCustomFieldRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomField'
description: ''
put:
operationId: extras_custom_fields_bulk_update
description: Put a list of custom field objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomFieldRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/CustomFieldRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomField'
description: ''
patch:
operationId: extras_custom_fields_bulk_partial_update
description: Patch a list of custom field objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomFieldRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/CustomFieldRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomField'
description: ''
delete:
operationId: extras_custom_fields_bulk_destroy
description: Delete a list of custom field objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomFieldRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/CustomFieldRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/custom-fields/{id}/:
get:
operationId: extras_custom_fields_retrieve
description: Get a custom field object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this custom field.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomField'
description: ''
put:
operationId: extras_custom_fields_update
description: Put a custom field object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this custom field.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WritableCustomFieldRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/WritableCustomFieldRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomField'
description: ''
patch:
operationId: extras_custom_fields_partial_update
description: Patch a custom field object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this custom field.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedWritableCustomFieldRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedWritableCustomFieldRequest'
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomField'
description: ''
delete:
operationId: extras_custom_fields_destroy
description: Delete a custom field object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this custom field.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/custom-links/:
get:
operationId: extras_custom_links_list
description: Get a list of custom link objects.
parameters:
- in: query
name: button_class
schema:
type: string
x-spec-enum-id: 5e54b3bd086685ce
enum:
- black
- blue
- cyan
- default
- ghost-dark
- gray
- green
- indigo
- 'null'
- orange
- pink
- purple
- red
- teal
- white
- yellow
description: 'The class of the first link in a group will be used for the dropdown button
* `default` - Default
* `blue` - Blue
* `indigo` - Indigo
* `purple` - Purple
* `pink` - Pink
* `red` - Red
* `orange` - Orange
* `yellow` - Yellow
* `green` - Green
* `teal` - Teal
* `cyan` - Cyan
* `gray` - Gray
* `black` - Black
* `white` - White
* `ghost-dark` - Link'
- in: query
name: button_class__empty
schema:
type: boolean
- in: query
name: button_class__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: button_class__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: button_class__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: button_class__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: button_class__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: button_class__n
schema:
type: string
x-spec-enum-id: 5e54b3bd086685ce
enum:
- black
- blue
- cyan
- default
- ghost-dark
- gray
- green
- indigo
- 'null'
- orange
- pink
- purple
- red
- teal
- white
- yellow
description: 'The class of the first link in a group will be used for the dropdown button
* `default` - Default
* `blue` - Blue
* `indigo` - Indigo
* `purple` - Purple
* `pink` - Pink
* `red` - Red
* `orange` - Orange
* `yellow` - Yellow
* `green` - Green
* `teal` - Teal
* `cyan` - Cyan
* `gray` - Gray
* `black` - Black
* `white` - White
* `ghost-dark` - Link'
- in: query
name: button_class__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: button_class__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: button_class__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: button_class__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: button_class__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: created
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created_by_request
schema:
type: string
format: uuid
- in: query
name: enabled
schema:
type: boolean
- in: query
name: group_name
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name__empty
schema:
type: boolean
- in: query
name: group_name__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: group_name__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__empty
schema:
type: boolean
- in: query
name: id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: last_updated
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: link_text
schema:
type: string
- in: query
name: link_text__ic
schema:
type: string
- in: query
name: link_text__ie
schema:
type: string
- in: query
name: link_text__iew
schema:
type: string
- in: query
name: link_text__iregex
schema:
type: string
- in: query
name: link_text__isw
schema:
type: string
- in: query
name: link_text__n
schema:
type: string
- in: query
name: link_text__nic
schema:
type: string
- in: query
name: link_text__nie
schema:
type: string
- in: query
name: link_text__niew
schema:
type: string
- in: query
name: link_text__nisw
schema:
type: string
- in: query
name: link_text__regex
schema:
type: string
- in: query
name: link_url
schema:
type: string
- in: query
name: link_url__ic
schema:
type: string
- in: query
name: link_url__ie
schema:
type: string
- in: query
name: link_url__iew
schema:
type: string
- in: query
name: link_url__iregex
schema:
type: string
- in: query
name: link_url__isw
schema:
type: string
- in: query
name: link_url__n
schema:
type: string
- in: query
name: link_url__nic
schema:
type: string
- in: query
name: link_url__nie
schema:
type: string
- in: query
name: link_url__niew
schema:
type: string
- in: query
name: link_url__nisw
schema:
type: string
- in: query
name: link_url__regex
schema:
type: string
- in: query
name: modified_by_request
schema:
type: string
format: uuid
- in: query
name: name
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__empty
schema:
type: boolean
- in: query
name: name__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: new_window
schema:
type: boolean
- in: query
name: object_type
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type_id
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: object_type_id__n
schema:
type: array
items:
type: integer
explode: true
style: form
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- in: query
name: owner
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner__n
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner_group
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group__n
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group_id
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_group_id__n
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_id
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: owner_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: q
schema:
type: string
description: Search
- in: query
name: updated_by_request
schema:
type: string
format: uuid
- in: query
name: weight
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__empty
schema:
type: boolean
- in: query
name: weight__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedCustomLinkList'
description: ''
post:
operationId: extras_custom_links_create
description: Post a list of custom link objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/CustomLinkRequest'
- type: array
items:
$ref: '#/components/schemas/CustomLinkRequest'
multipart/form-data:
schema:
oneOf:
- $ref: '#/components/schemas/CustomLinkRequest'
- type: array
items:
$ref: '#/components/schemas/CustomLinkRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomLink'
description: ''
put:
operationId: extras_custom_links_bulk_update
description: Put a list of custom link objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomLinkRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/CustomLinkRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomLink'
description: ''
patch:
operationId: extras_custom_links_bulk_partial_update
description: Patch a list of custom link objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomLinkRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/CustomLinkRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomLink'
description: ''
delete:
operationId: extras_custom_links_bulk_destroy
description: Delete a list of custom link objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomLinkRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/CustomLinkRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/custom-links/{id}/:
get:
operationId: extras_custom_links_retrieve
description: Get a custom link object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this custom link.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomLink'
description: ''
put:
operationId: extras_custom_links_update
description: Put a custom link object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this custom link.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CustomLinkRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/CustomLinkRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomLink'
description: ''
patch:
operationId: extras_custom_links_partial_update
description: Patch a custom link object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this custom link.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedCustomLinkRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedCustomLinkRequest'
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomLink'
description: ''
delete:
operationId: extras_custom_links_destroy
description: Delete a custom link object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this custom link.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/dashboard/:
get:
operationId: extras_dashboard_retrieve
description: Get a list of dashboard objects.
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Dashboard'
description: ''
put:
operationId: extras_dashboard_update
description: Put a list of dashboard objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/DashboardRequest'
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Dashboard'
description: ''
patch:
operationId: extras_dashboard_partial_update
description: Patch a list of dashboard objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedDashboardRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedDashboardRequest'
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Dashboard'
description: ''
delete:
operationId: extras_dashboard_destroy
description: Delete a list of dashboard objects.
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/event-rules/:
get:
operationId: extras_event_rules_list
description: Get a list of event rule objects.
parameters:
- in: query
name: action_object_id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: action_object_id__empty
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: action_object_id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: action_object_id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: action_object_id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: action_object_id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: action_object_id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: action_object_type
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: action_object_type__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: action_type
schema:
type: array
items:
type: string
x-spec-enum-id: 287901b937995956
explode: true
style: form
- in: query
name: action_type__empty
schema:
type: boolean
- in: query
name: action_type__ic
schema:
type: array
items:
type: string
x-spec-enum-id: 287901b937995956
explode: true
style: form
- in: query
name: action_type__ie
schema:
type: array
items:
type: string
x-spec-enum-id: 287901b937995956
explode: true
style: form
- in: query
name: action_type__iew
schema:
type: array
items:
type: string
x-spec-enum-id: 287901b937995956
explode: true
style: form
- in: query
name: action_type__iregex
schema:
type: array
items:
type: string
x-spec-enum-id: 287901b937995956
explode: true
style: form
- in: query
name: action_type__isw
schema:
type: array
items:
type: string
x-spec-enum-id: 287901b937995956
explode: true
style: form
- in: query
name: action_type__n
schema:
type: array
items:
type: string
x-spec-enum-id: 287901b937995956
explode: true
style: form
- in: query
name: action_type__nic
schema:
type: array
items:
type: string
x-spec-enum-id: 287901b937995956
explode: true
style: form
- in: query
name: action_type__nie
schema:
type: array
items:
type: string
x-spec-enum-id: 287901b937995956
explode: true
style: form
- in: query
name: action_type__niew
schema:
type: array
items:
type: string
x-spec-enum-id: 287901b937995956
explode: true
style: form
- in: query
name: action_type__nisw
schema:
type: array
items:
type: string
x-spec-enum-id: 287901b937995956
explode: true
style: form
- in: query
name: action_type__regex
schema:
type: array
items:
type: string
x-spec-enum-id: 287901b937995956
explode: true
style: form
- in: query
name: created
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created_by_request
schema:
type: string
format: uuid
- in: query
name: description
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__empty
schema:
type: boolean
- in: query
name: description__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: enabled
schema:
type: boolean
- in: query
name: event_type
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__empty
schema:
type: boolean
- in: query
name: id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: last_updated
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: modified_by_request
schema:
type: string
format: uuid
- in: query
name: name
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__empty
schema:
type: boolean
- in: query
name: name__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type_id
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: object_type_id__n
schema:
type: array
items:
type: integer
explode: true
style: form
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- in: query
name: owner
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner__n
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner_group
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group__n
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group_id
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_group_id__n
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_id
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: owner_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: q
schema:
type: string
description: Search
- in: query
name: tag
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: tag__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: tag_id
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: tag_id__n
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: updated_by_request
schema:
type: string
format: uuid
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedEventRuleList'
description: ''
post:
operationId: extras_event_rules_create
description: Post a list of event rule objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/WritableEventRuleRequest'
- type: array
items:
$ref: '#/components/schemas/WritableEventRuleRequest'
multipart/form-data:
schema:
oneOf:
- $ref: '#/components/schemas/WritableEventRuleRequest'
- type: array
items:
$ref: '#/components/schemas/WritableEventRuleRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/EventRule'
description: ''
put:
operationId: extras_event_rules_bulk_update
description: Put a list of event rule objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/EventRuleRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/EventRuleRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/EventRule'
description: ''
patch:
operationId: extras_event_rules_bulk_partial_update
description: Patch a list of event rule objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/EventRuleRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/EventRuleRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/EventRule'
description: ''
delete:
operationId: extras_event_rules_bulk_destroy
description: Delete a list of event rule objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/EventRuleRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/EventRuleRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/event-rules/{id}/:
get:
operationId: extras_event_rules_retrieve
description: Get a event rule object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this event rule.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/EventRule'
description: ''
put:
operationId: extras_event_rules_update
description: Put a event rule object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this event rule.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WritableEventRuleRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/WritableEventRuleRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/EventRule'
description: ''
patch:
operationId: extras_event_rules_partial_update
description: Patch a event rule object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this event rule.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedWritableEventRuleRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedWritableEventRuleRequest'
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/EventRule'
description: ''
delete:
operationId: extras_event_rules_destroy
description: Delete a event rule object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this event rule.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/export-templates/:
get:
operationId: extras_export_templates_list
description: Get a list of export template objects.
parameters:
- in: query
name: as_attachment
schema:
type: boolean
- in: query
name: auto_sync_enabled
schema:
type: boolean
- in: query
name: created
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created_by_request
schema:
type: string
format: uuid
- in: query
name: data_file_id
schema:
type: array
items:
type: integer
nullable: true
description: Data file (ID)
explode: true
style: form
- in: query
name: data_file_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Data file (ID)
explode: true
style: form
- in: query
name: data_source_id
schema:
type: array
items:
type: integer
nullable: true
description: Data source (ID)
explode: true
style: form
- in: query
name: data_source_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Data source (ID)
explode: true
style: form
- in: query
name: data_synced
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: data_synced__empty
schema:
type: boolean
- in: query
name: data_synced__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: data_synced__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: data_synced__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: data_synced__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: data_synced__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: description
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__empty
schema:
type: boolean
- in: query
name: description__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension__empty
schema:
type: boolean
- in: query
name: file_extension__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_extension__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name__empty
schema:
type: boolean
- in: query
name: file_name__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: file_name__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__empty
schema:
type: boolean
- in: query
name: id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: last_updated
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: mime_type
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: mime_type__empty
schema:
type: boolean
- in: query
name: mime_type__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: mime_type__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: mime_type__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: mime_type__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: mime_type__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: mime_type__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: mime_type__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: mime_type__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: mime_type__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: mime_type__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: mime_type__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: modified_by_request
schema:
type: string
format: uuid
- in: query
name: name
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__empty
schema:
type: boolean
- in: query
name: name__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type_id
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: object_type_id__n
schema:
type: array
items:
type: integer
explode: true
style: form
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- in: query
name: owner
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner__n
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner_group
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group__n
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group_id
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_group_id__n
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_id
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: owner_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: q
schema:
type: string
description: Search
- in: query
name: updated_by_request
schema:
type: string
format: uuid
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedExportTemplateList'
description: ''
post:
operationId: extras_export_templates_create
description: Post a list of export template objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ExportTemplateRequest'
- type: array
items:
$ref: '#/components/schemas/ExportTemplateRequest'
multipart/form-data:
schema:
oneOf:
- $ref: '#/components/schemas/ExportTemplateRequest'
- type: array
items:
$ref: '#/components/schemas/ExportTemplateRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ExportTemplate'
description: ''
put:
operationId: extras_export_templates_bulk_update
description: Put a list of export template objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ExportTemplateRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/ExportTemplateRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ExportTemplate'
description: ''
patch:
operationId: extras_export_templates_bulk_partial_update
description: Patch a list of export template objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ExportTemplateRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/ExportTemplateRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ExportTemplate'
description: ''
delete:
operationId: extras_export_templates_bulk_destroy
description: Delete a list of export template objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ExportTemplateRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/ExportTemplateRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/export-templates/{id}/:
get:
operationId: extras_export_templates_retrieve
description: Get a export template object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this export template.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExportTemplate'
description: ''
put:
operationId: extras_export_templates_update
description: Put a export template object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this export template.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExportTemplateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ExportTemplateRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExportTemplate'
description: ''
patch:
operationId: extras_export_templates_partial_update
description: Patch a export template object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this export template.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedExportTemplateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedExportTemplateRequest'
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExportTemplate'
description: ''
delete:
operationId: extras_export_templates_destroy
description: Delete a export template object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this export template.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/export-templates/{id}/sync/:
post:
operationId: extras_export_templates_sync_create
description: Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any).
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this export template.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExportTemplateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ExportTemplateRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExportTemplate'
description: ''
/api/extras/image-attachments/:
get:
operationId: extras_image_attachments_list
description: Get a list of image attachment objects.
parameters:
- in: query
name: created
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created_by_request
schema:
type: string
format: uuid
- in: query
name: description
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__empty
schema:
type: boolean
- in: query
name: description__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__empty
schema:
type: boolean
- in: query
name: id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: image_height
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: image_height__empty
schema:
type: boolean
- in: query
name: image_height__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: image_height__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: image_height__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: image_height__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: image_height__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: image_width
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: image_width__empty
schema:
type: boolean
- in: query
name: image_width__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: image_width__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: image_width__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: image_width__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: image_width__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: last_updated
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: modified_by_request
schema:
type: string
format: uuid
- in: query
name: name
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__empty
schema:
type: boolean
- in: query
name: name__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_id__empty
schema:
type: boolean
- in: query
name: object_id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_type
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type_id
schema:
type: integer
- in: query
name: object_type_id__n
schema:
type: integer
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- in: query
name: q
schema:
type: string
description: Search
- in: query
name: updated_by_request
schema:
type: string
format: uuid
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedImageAttachmentList'
description: ''
post:
operationId: extras_image_attachments_create
description: Post a list of image attachment objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ImageAttachmentRequest'
- type: array
items:
$ref: '#/components/schemas/ImageAttachmentRequest'
multipart/form-data:
schema:
oneOf:
- $ref: '#/components/schemas/ImageAttachmentRequest'
- type: array
items:
$ref: '#/components/schemas/ImageAttachmentRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ImageAttachment'
description: ''
put:
operationId: extras_image_attachments_bulk_update
description: Put a list of image attachment objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ImageAttachmentRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/ImageAttachmentRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ImageAttachment'
description: ''
patch:
operationId: extras_image_attachments_bulk_partial_update
description: Patch a list of image attachment objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ImageAttachmentRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/ImageAttachmentRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ImageAttachment'
description: ''
delete:
operationId: extras_image_attachments_bulk_destroy
description: Delete a list of image attachment objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ImageAttachmentRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/ImageAttachmentRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/image-attachments/{id}/:
get:
operationId: extras_image_attachments_retrieve
description: Get a image attachment object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this image attachment.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ImageAttachment'
description: ''
put:
operationId: extras_image_attachments_update
description: Put a image attachment object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this image attachment.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ImageAttachmentRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ImageAttachmentRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ImageAttachment'
description: ''
patch:
operationId: extras_image_attachments_partial_update
description: Patch a image attachment object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this image attachment.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedImageAttachmentRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedImageAttachmentRequest'
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ImageAttachment'
description: ''
delete:
operationId: extras_image_attachments_destroy
description: Delete a image attachment object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this image attachment.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/journal-entries/:
get:
operationId: extras_journal_entries_list
description: Get a list of journal entry objects.
parameters:
- in: query
name: assigned_object_id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: assigned_object_id__empty
schema:
type: boolean
- in: query
name: assigned_object_id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: assigned_object_id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: assigned_object_id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: assigned_object_id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: assigned_object_id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: assigned_object_type
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: assigned_object_type__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: assigned_object_type_id
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: assigned_object_type_id__n
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: created_after
schema:
type: string
format: date-time
- in: query
name: created_before
schema:
type: string
format: date-time
- in: query
name: created_by
schema:
type: array
items:
type: string
description: User (name)
explode: true
style: form
- in: query
name: created_by__n
schema:
type: array
items:
type: string
description: User (name)
explode: true
style: form
- in: query
name: created_by_id
schema:
type: array
items:
type: integer
nullable: true
description: User (ID)
explode: true
style: form
- in: query
name: created_by_id__n
schema:
type: array
items:
type: integer
nullable: true
description: User (ID)
explode: true
style: form
- in: query
name: created_by_request
schema:
type: string
format: uuid
- in: query
name: id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__empty
schema:
type: boolean
- in: query
name: id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: kind
schema:
type: array
items:
type: string
x-spec-enum-id: 6f65abe0aab2c78c
explode: true
style: form
- in: query
name: kind__empty
schema:
type: boolean
- in: query
name: kind__ic
schema:
type: array
items:
type: string
x-spec-enum-id: 6f65abe0aab2c78c
explode: true
style: form
- in: query
name: kind__ie
schema:
type: array
items:
type: string
x-spec-enum-id: 6f65abe0aab2c78c
explode: true
style: form
- in: query
name: kind__iew
schema:
type: array
items:
type: string
x-spec-enum-id: 6f65abe0aab2c78c
explode: true
style: form
- in: query
name: kind__iregex
schema:
type: array
items:
type: string
x-spec-enum-id: 6f65abe0aab2c78c
explode: true
style: form
- in: query
name: kind__isw
schema:
type: array
items:
type: string
x-spec-enum-id: 6f65abe0aab2c78c
explode: true
style: form
- in: query
name: kind__n
schema:
type: array
items:
type: string
x-spec-enum-id: 6f65abe0aab2c78c
explode: true
style: form
- in: query
name: kind__nic
schema:
type: array
items:
type: string
x-spec-enum-id: 6f65abe0aab2c78c
explode: true
style: form
- in: query
name: kind__nie
schema:
type: array
items:
type: string
x-spec-enum-id: 6f65abe0aab2c78c
explode: true
style: form
- in: query
name: kind__niew
schema:
type: array
items:
type: string
x-spec-enum-id: 6f65abe0aab2c78c
explode: true
style: form
- in: query
name: kind__nisw
schema:
type: array
items:
type: string
x-spec-enum-id: 6f65abe0aab2c78c
explode: true
style: form
- in: query
name: kind__regex
schema:
type: array
items:
type: string
x-spec-enum-id: 6f65abe0aab2c78c
explode: true
style: form
- in: query
name: last_updated
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: modified_by_request
schema:
type: string
format: uuid
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- in: query
name: q
schema:
type: string
description: Search
- in: query
name: tag
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: tag__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: tag_id
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: tag_id__n
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: updated_by_request
schema:
type: string
format: uuid
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedJournalEntryList'
description: ''
post:
operationId: extras_journal_entries_create
description: Post a list of journal entry objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/WritableJournalEntryRequest'
- type: array
items:
$ref: '#/components/schemas/WritableJournalEntryRequest'
multipart/form-data:
schema:
oneOf:
- $ref: '#/components/schemas/WritableJournalEntryRequest'
- type: array
items:
$ref: '#/components/schemas/WritableJournalEntryRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/JournalEntry'
description: ''
put:
operationId: extras_journal_entries_bulk_update
description: Put a list of journal entry objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/JournalEntryRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/JournalEntryRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/JournalEntry'
description: ''
patch:
operationId: extras_journal_entries_bulk_partial_update
description: Patch a list of journal entry objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/JournalEntryRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/JournalEntryRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/JournalEntry'
description: ''
delete:
operationId: extras_journal_entries_bulk_destroy
description: Delete a list of journal entry objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/JournalEntryRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/JournalEntryRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/journal-entries/{id}/:
get:
operationId: extras_journal_entries_retrieve
description: Get a journal entry object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this journal entry.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/JournalEntry'
description: ''
put:
operationId: extras_journal_entries_update
description: Put a journal entry object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this journal entry.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WritableJournalEntryRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/WritableJournalEntryRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/JournalEntry'
description: ''
patch:
operationId: extras_journal_entries_partial_update
description: Patch a journal entry object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this journal entry.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedWritableJournalEntryRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedWritableJournalEntryRequest'
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/JournalEntry'
description: ''
delete:
operationId: extras_journal_entries_destroy
description: Delete a journal entry object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this journal entry.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/notification-groups/:
get:
operationId: extras_notification_groups_list
description: Get a list of notification group objects.
parameters:
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedNotificationGroupList'
description: ''
post:
operationId: extras_notification_groups_create
description: Post a list of notification group objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/NotificationGroupRequest'
- type: array
items:
$ref: '#/components/schemas/NotificationGroupRequest'
multipart/form-data:
schema:
oneOf:
- $ref: '#/components/schemas/NotificationGroupRequest'
- type: array
items:
$ref: '#/components/schemas/NotificationGroupRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationGroup'
description: ''
put:
operationId: extras_notification_groups_bulk_update
description: Put a list of notification group objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NotificationGroupRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/NotificationGroupRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NotificationGroup'
description: ''
patch:
operationId: extras_notification_groups_bulk_partial_update
description: Patch a list of notification group objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NotificationGroupRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/NotificationGroupRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NotificationGroup'
description: ''
delete:
operationId: extras_notification_groups_bulk_destroy
description: Delete a list of notification group objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NotificationGroupRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/NotificationGroupRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/notification-groups/{id}/:
get:
operationId: extras_notification_groups_retrieve
description: Get a notification group object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this notification group.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationGroup'
description: ''
put:
operationId: extras_notification_groups_update
description: Put a notification group object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this notification group.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationGroupRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/NotificationGroupRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationGroup'
description: ''
patch:
operationId: extras_notification_groups_partial_update
description: Patch a notification group object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this notification group.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedNotificationGroupRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedNotificationGroupRequest'
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationGroup'
description: ''
delete:
operationId: extras_notification_groups_destroy
description: Delete a notification group object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this notification group.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/notifications/:
get:
operationId: extras_notifications_list
description: Get a list of notification objects.
parameters:
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedNotificationList'
description: ''
post:
operationId: extras_notifications_create
description: Post a list of notification objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/NotificationRequest'
- type: array
items:
$ref: '#/components/schemas/NotificationRequest'
multipart/form-data:
schema:
oneOf:
- $ref: '#/components/schemas/NotificationRequest'
- type: array
items:
$ref: '#/components/schemas/NotificationRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Notification'
description: ''
put:
operationId: extras_notifications_bulk_update
description: Put a list of notification objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NotificationRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/NotificationRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Notification'
description: ''
patch:
operationId: extras_notifications_bulk_partial_update
description: Patch a list of notification objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NotificationRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/NotificationRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Notification'
description: ''
delete:
operationId: extras_notifications_bulk_destroy
description: Delete a list of notification objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NotificationRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/NotificationRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/notifications/{id}/:
get:
operationId: extras_notifications_retrieve
description: Get a notification object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this notification.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Notification'
description: ''
put:
operationId: extras_notifications_update
description: Put a notification object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this notification.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/NotificationRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Notification'
description: ''
patch:
operationId: extras_notifications_partial_update
description: Patch a notification object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this notification.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedNotificationRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedNotificationRequest'
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Notification'
description: ''
delete:
operationId: extras_notifications_destroy
description: Delete a notification object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this notification.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/saved-filters/:
get:
operationId: extras_saved_filters_list
description: Get a list of saved filter objects.
parameters:
- in: query
name: created
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created_by_request
schema:
type: string
format: uuid
- in: query
name: description
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__empty
schema:
type: boolean
- in: query
name: description__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: enabled
schema:
type: boolean
- in: query
name: id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__empty
schema:
type: boolean
- in: query
name: id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: last_updated
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: modified_by_request
schema:
type: string
format: uuid
- in: query
name: name
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__empty
schema:
type: boolean
- in: query
name: name__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type_id
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: object_type_id__n
schema:
type: array
items:
type: integer
explode: true
style: form
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- in: query
name: owner
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner__n
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner_group
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group__n
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group_id
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_group_id__n
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_id
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: owner_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: q
schema:
type: string
description: Search
- in: query
name: shared
schema:
type: boolean
- in: query
name: slug
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__empty
schema:
type: boolean
- in: query
name: slug__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: updated_by_request
schema:
type: string
format: uuid
- in: query
name: usable
schema:
type: boolean
- in: query
name: user
schema:
type: array
items:
type: string
description: User (name)
explode: true
style: form
- in: query
name: user__n
schema:
type: array
items:
type: string
description: User (name)
explode: true
style: form
- in: query
name: user_id
schema:
type: array
items:
type: integer
nullable: true
description: User (ID)
explode: true
style: form
- in: query
name: user_id__n
schema:
type: array
items:
type: integer
nullable: true
description: User (ID)
explode: true
style: form
- in: query
name: weight
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__empty
schema:
type: boolean
- in: query
name: weight__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedSavedFilterList'
description: ''
post:
operationId: extras_saved_filters_create
description: Post a list of saved filter objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/SavedFilterRequest'
- type: array
items:
$ref: '#/components/schemas/SavedFilterRequest'
multipart/form-data:
schema:
oneOf:
- $ref: '#/components/schemas/SavedFilterRequest'
- type: array
items:
$ref: '#/components/schemas/SavedFilterRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/SavedFilter'
description: ''
put:
operationId: extras_saved_filters_bulk_update
description: Put a list of saved filter objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SavedFilterRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/SavedFilterRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SavedFilter'
description: ''
patch:
operationId: extras_saved_filters_bulk_partial_update
description: Patch a list of saved filter objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SavedFilterRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/SavedFilterRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SavedFilter'
description: ''
delete:
operationId: extras_saved_filters_bulk_destroy
description: Delete a list of saved filter objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SavedFilterRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/SavedFilterRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/saved-filters/{id}/:
get:
operationId: extras_saved_filters_retrieve
description: Get a saved filter object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this saved filter.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SavedFilter'
description: ''
put:
operationId: extras_saved_filters_update
description: Put a saved filter object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this saved filter.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SavedFilterRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/SavedFilterRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SavedFilter'
description: ''
patch:
operationId: extras_saved_filters_partial_update
description: Patch a saved filter object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this saved filter.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedSavedFilterRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedSavedFilterRequest'
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SavedFilter'
description: ''
delete:
operationId: extras_saved_filters_destroy
description: Delete a saved filter object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this saved filter.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/scripts/:
get:
operationId: extras_scripts_list
description: Get a list of script objects.
parameters:
- in: query
name: id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__empty
schema:
type: boolean
- in: query
name: id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: is_executable
schema:
type: boolean
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: module_id
schema:
type: array
items:
type: integer
description: Script module (ID)
explode: true
style: form
- in: query
name: module_id__n
schema:
type: array
items:
type: integer
description: Script module (ID)
explode: true
style: form
- in: query
name: name
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__empty
schema:
type: boolean
- in: query
name: name__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__regex
schema:
type: array
items:
type: string
explode: true
style: form
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- in: query
name: q
schema:
type: string
description: Search
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedScriptList'
description: ''
post:
operationId: extras_scripts_create
description: Post a list of script objects.
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Script'
description: ''
/api/extras/scripts/{id}/:
get:
operationId: extras_scripts_retrieve
description: Get a script object.
parameters:
- in: path
name: id
schema:
type: string
pattern: ^[^/]+$
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Script'
description: ''
put:
operationId: extras_scripts_update
description: Put a script object.
parameters:
- in: path
name: id
schema:
type: string
pattern: ^[^/]+$
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ScriptInputRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ScriptInputRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Script'
description: ''
patch:
operationId: extras_scripts_partial_update
description: Patch a script object.
parameters:
- in: path
name: id
schema:
type: string
pattern: ^[^/]+$
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedScriptInputRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedScriptInputRequest'
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Script'
description: ''
delete:
operationId: extras_scripts_destroy
description: Delete a script object.
parameters:
- in: path
name: id
schema:
type: string
pattern: ^[^/]+$
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/scripts/upload/:
post:
operationId: extras_scripts_upload_create
description: Post a list of script module objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ScriptModuleRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ScriptModuleRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ScriptModule'
description: ''
/api/extras/subscriptions/:
get:
operationId: extras_subscriptions_list
description: Get a list of subscription objects.
parameters:
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedSubscriptionList'
description: ''
post:
operationId: extras_subscriptions_create
description: Post a list of subscription objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/SubscriptionRequest'
- type: array
items:
$ref: '#/components/schemas/SubscriptionRequest'
multipart/form-data:
schema:
oneOf:
- $ref: '#/components/schemas/SubscriptionRequest'
- type: array
items:
$ref: '#/components/schemas/SubscriptionRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Subscription'
description: ''
put:
operationId: extras_subscriptions_bulk_update
description: Put a list of subscription objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SubscriptionRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/SubscriptionRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Subscription'
description: ''
patch:
operationId: extras_subscriptions_bulk_partial_update
description: Patch a list of subscription objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SubscriptionRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/SubscriptionRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Subscription'
description: ''
delete:
operationId: extras_subscriptions_bulk_destroy
description: Delete a list of subscription objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SubscriptionRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/SubscriptionRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/subscriptions/{id}/:
get:
operationId: extras_subscriptions_retrieve
description: Get a subscription object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this subscription.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Subscription'
description: ''
put:
operationId: extras_subscriptions_update
description: Put a subscription object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this subscription.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/SubscriptionRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Subscription'
description: ''
patch:
operationId: extras_subscriptions_partial_update
description: Patch a subscription object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this subscription.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedSubscriptionRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedSubscriptionRequest'
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Subscription'
description: ''
delete:
operationId: extras_subscriptions_destroy
description: Delete a subscription object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this subscription.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/table-configs/:
get:
operationId: extras_table_configs_list
description: Get a list of table config objects.
parameters:
- in: query
name: created
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created_by_request
schema:
type: string
format: uuid
- in: query
name: description
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__empty
schema:
type: boolean
- in: query
name: description__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: enabled
schema:
type: boolean
- in: query
name: id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__empty
schema:
type: boolean
- in: query
name: id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: last_updated
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: modified_by_request
schema:
type: string
format: uuid
- in: query
name: name
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__empty
schema:
type: boolean
- in: query
name: name__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type_id
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: object_type_id__n
schema:
type: array
items:
type: integer
explode: true
style: form
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- in: query
name: q
schema:
type: string
description: Search
- in: query
name: shared
schema:
type: boolean
- in: query
name: table
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: table__empty
schema:
type: boolean
- in: query
name: table__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: table__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: table__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: table__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: table__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: table__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: table__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: table__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: table__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: table__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: table__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: updated_by_request
schema:
type: string
format: uuid
- in: query
name: usable
schema:
type: boolean
- in: query
name: user
schema:
type: array
items:
type: string
description: User (name)
explode: true
style: form
- in: query
name: user__n
schema:
type: array
items:
type: string
description: User (name)
explode: true
style: form
- in: query
name: user_id
schema:
type: array
items:
type: integer
nullable: true
description: User (ID)
explode: true
style: form
- in: query
name: user_id__n
schema:
type: array
items:
type: integer
nullable: true
description: User (ID)
explode: true
style: form
- in: query
name: weight
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__empty
schema:
type: boolean
- in: query
name: weight__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedTableConfigList'
description: ''
post:
operationId: extras_table_configs_create
description: Post a list of table config objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/TableConfigRequest'
- type: array
items:
$ref: '#/components/schemas/TableConfigRequest'
multipart/form-data:
schema:
oneOf:
- $ref: '#/components/schemas/TableConfigRequest'
- type: array
items:
$ref: '#/components/schemas/TableConfigRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/TableConfig'
description: ''
put:
operationId: extras_table_configs_bulk_update
description: Put a list of table config objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TableConfigRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/TableConfigRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TableConfig'
description: ''
patch:
operationId: extras_table_configs_bulk_partial_update
description: Patch a list of table config objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TableConfigRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/TableConfigRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TableConfig'
description: ''
delete:
operationId: extras_table_configs_bulk_destroy
description: Delete a list of table config objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TableConfigRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/TableConfigRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/table-configs/{id}/:
get:
operationId: extras_table_configs_retrieve
description: Get a table config object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this table config.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TableConfig'
description: ''
put:
operationId: extras_table_configs_update
description: Put a table config object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this table config.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TableConfigRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/TableConfigRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TableConfig'
description: ''
patch:
operationId: extras_table_configs_partial_update
description: Patch a table config object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this table config.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedTableConfigRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedTableConfigRequest'
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TableConfig'
description: ''
delete:
operationId: extras_table_configs_destroy
description: Delete a table config object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this table config.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/tagged-objects/:
get:
operationId: extras_tagged_objects_list
description: Get a list of tagged item objects.
parameters:
- in: query
name: id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__empty
schema:
type: boolean
- in: query
name: id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: object_id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_id__empty
schema:
type: boolean
- in: query
name: object_id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: object_type
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_type_id
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: object_type_id__n
schema:
type: array
items:
type: integer
explode: true
style: form
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- in: query
name: q
schema:
type: string
description: Search
- in: query
name: tag
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: tag__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: tag_id
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: tag_id__n
schema:
type: array
items:
type: integer
explode: true
style: form
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedTaggedItemList'
description: ''
/api/extras/tagged-objects/{id}/:
get:
operationId: extras_tagged_objects_retrieve
description: Get a tagged item object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this tagged item.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TaggedItem'
description: ''
/api/extras/tags/:
get:
operationId: extras_tags_list
description: Get a list of tag objects.
parameters:
- in: query
name: color
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: color__empty
schema:
type: boolean
- in: query
name: color__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: color__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: color__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: color__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: color__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: color__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: color__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: color__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: color__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: color__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: color__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: content_type
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: content_type_id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: created
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created_by_request
schema:
type: string
format: uuid
- in: query
name: description
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__empty
schema:
type: boolean
- in: query
name: description__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: for_object_type_id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__empty
schema:
type: boolean
- in: query
name: id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: last_updated
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: modified_by_request
schema:
type: string
format: uuid
- in: query
name: name
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__empty
schema:
type: boolean
- in: query
name: name__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: object_types
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: object_types__n
schema:
type: array
items:
type: integer
explode: true
style: form
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- in: query
name: owner
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner__n
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner_group
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group__n
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group_id
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_group_id__n
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_id
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: owner_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: q
schema:
type: string
description: Search
- in: query
name: slug
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__empty
schema:
type: boolean
- in: query
name: slug__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: updated_by_request
schema:
type: string
format: uuid
- in: query
name: weight
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__empty
schema:
type: boolean
- in: query
name: weight__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: weight__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedTagList'
description: ''
post:
operationId: extras_tags_create
description: Post a list of tag objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/TagRequest'
- type: array
items:
$ref: '#/components/schemas/TagRequest'
multipart/form-data:
schema:
oneOf:
- $ref: '#/components/schemas/TagRequest'
- type: array
items:
$ref: '#/components/schemas/TagRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
description: ''
put:
operationId: extras_tags_bulk_update
description: Put a list of tag objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TagRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/TagRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
patch:
operationId: extras_tags_bulk_partial_update
description: Patch a list of tag objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TagRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/TagRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
delete:
operationId: extras_tags_bulk_destroy
description: Delete a list of tag objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TagRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/TagRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/tags/{id}/:
get:
operationId: extras_tags_retrieve
description: Get a tag object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this tag.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
description: ''
put:
operationId: extras_tags_update
description: Put a tag object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this tag.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TagRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/TagRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
description: ''
patch:
operationId: extras_tags_partial_update
description: Patch a tag object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this tag.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedTagRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedTagRequest'
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
description: ''
delete:
operationId: extras_tags_destroy
description: Delete a tag object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this tag.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/webhooks/:
get:
operationId: extras_webhooks_list
description: Get a list of webhook objects.
parameters:
- in: query
name: ca_file_path
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ca_file_path__empty
schema:
type: boolean
- in: query
name: ca_file_path__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ca_file_path__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ca_file_path__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ca_file_path__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ca_file_path__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ca_file_path__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ca_file_path__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ca_file_path__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ca_file_path__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ca_file_path__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ca_file_path__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: created
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created_by_request
schema:
type: string
format: uuid
- in: query
name: description
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__empty
schema:
type: boolean
- in: query
name: description__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: http_content_type
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: http_content_type__empty
schema:
type: boolean
- in: query
name: http_content_type__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: http_content_type__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: http_content_type__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: http_content_type__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: http_content_type__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: http_content_type__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: http_content_type__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: http_content_type__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: http_content_type__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: http_content_type__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: http_content_type__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: http_method
schema:
type: array
items:
type: string
x-spec-enum-id: 867bf764d3b1eeaa
explode: true
style: form
- in: query
name: http_method__empty
schema:
type: boolean
- in: query
name: http_method__ic
schema:
type: array
items:
type: string
x-spec-enum-id: 867bf764d3b1eeaa
explode: true
style: form
- in: query
name: http_method__ie
schema:
type: array
items:
type: string
x-spec-enum-id: 867bf764d3b1eeaa
explode: true
style: form
- in: query
name: http_method__iew
schema:
type: array
items:
type: string
x-spec-enum-id: 867bf764d3b1eeaa
explode: true
style: form
- in: query
name: http_method__iregex
schema:
type: array
items:
type: string
x-spec-enum-id: 867bf764d3b1eeaa
explode: true
style: form
- in: query
name: http_method__isw
schema:
type: array
items:
type: string
x-spec-enum-id: 867bf764d3b1eeaa
explode: true
style: form
- in: query
name: http_method__n
schema:
type: array
items:
type: string
x-spec-enum-id: 867bf764d3b1eeaa
explode: true
style: form
- in: query
name: http_method__nic
schema:
type: array
items:
type: string
x-spec-enum-id: 867bf764d3b1eeaa
explode: true
style: form
- in: query
name: http_method__nie
schema:
type: array
items:
type: string
x-spec-enum-id: 867bf764d3b1eeaa
explode: true
style: form
- in: query
name: http_method__niew
schema:
type: array
items:
type: string
x-spec-enum-id: 867bf764d3b1eeaa
explode: true
style: form
- in: query
name: http_method__nisw
schema:
type: array
items:
type: string
x-spec-enum-id: 867bf764d3b1eeaa
explode: true
style: form
- in: query
name: http_method__regex
schema:
type: array
items:
type: string
x-spec-enum-id: 867bf764d3b1eeaa
explode: true
style: form
- in: query
name: id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__empty
schema:
type: boolean
- in: query
name: id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: last_updated
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: modified_by_request
schema:
type: string
format: uuid
- in: query
name: name
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__empty
schema:
type: boolean
- in: query
name: name__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__regex
schema:
type: array
items:
type: string
explode: true
style: form
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- in: query
name: owner
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner__n
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner_group
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group__n
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group_id
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_group_id__n
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_id
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: owner_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: payload_url
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: q
schema:
type: string
description: Search
- in: query
name: secret
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: secret__empty
schema:
type: boolean
- in: query
name: secret__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: secret__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: secret__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: secret__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: secret__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: secret__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: secret__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: secret__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: secret__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: secret__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: secret__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ssl_verification
schema:
type: boolean
- in: query
name: tag
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: tag__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: tag_id
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: tag_id__n
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: updated_by_request
schema:
type: string
format: uuid
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedWebhookList'
description: ''
post:
operationId: extras_webhooks_create
description: Post a list of webhook objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/WebhookRequest'
- type: array
items:
$ref: '#/components/schemas/WebhookRequest'
multipart/form-data:
schema:
oneOf:
- $ref: '#/components/schemas/WebhookRequest'
- type: array
items:
$ref: '#/components/schemas/WebhookRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
description: ''
put:
operationId: extras_webhooks_bulk_update
description: Put a list of webhook objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/WebhookRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/WebhookRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Webhook'
description: ''
patch:
operationId: extras_webhooks_bulk_partial_update
description: Patch a list of webhook objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/WebhookRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/WebhookRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Webhook'
description: ''
delete:
operationId: extras_webhooks_bulk_destroy
description: Delete a list of webhook objects.
tags:
- extras
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/WebhookRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/WebhookRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/extras/webhooks/{id}/:
get:
operationId: extras_webhooks_retrieve
description: Get a webhook object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this webhook.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
description: ''
put:
operationId: extras_webhooks_update
description: Put a webhook object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this webhook.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/WebhookRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
description: ''
patch:
operationId: extras_webhooks_partial_update
description: Patch a webhook object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this webhook.
required: true
tags:
- extras
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedWebhookRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedWebhookRequest'
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
description: ''
delete:
operationId: extras_webhooks_destroy
description: Delete a webhook object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this webhook.
required: true
tags:
- extras
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
components:
schemas:
BookmarkRequest:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
object_type:
type: string
object_id:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
user:
oneOf:
- type: integer
- $ref: '#/components/schemas/BriefUserRequest'
required:
- object_id
- object_type
- user
Platform:
type: object
description: Base serializer class for models inheriting from NestedGroupModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
parent:
allOf:
- $ref: '#/components/schemas/NestedPlatform'
nullable: true
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
manufacturer:
allOf:
- $ref: '#/components/schemas/BriefManufacturer'
nullable: true
config_template:
allOf:
- $ref: '#/components/schemas/BriefConfigTemplate'
nullable: true
description:
type: string
maxLength: 200
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
comments:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
custom_fields:
type: object
additionalProperties: {}
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
device_count:
type: integer
readOnly: true
default: 0
virtualmachine_count:
type: integer
readOnly: true
default: 0
_depth:
type: integer
readOnly: true
title: ' depth'
required:
- _depth
- created
- device_count
- display
- display_url
- id
- last_updated
- name
- slug
- url
- virtualmachine_count
ExportTemplate:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
object_types:
type: array
items:
type: string
name:
type: string
maxLength: 100
description:
type: string
maxLength: 200
environment_params:
nullable: true
title: Environment parameters
description: Any additional parameters to pass when constructing the Jinja environment
template_code:
type: string
description: Jinja template code.
mime_type:
type: string
description: Defaults to text/plain; charset=utf-8
maxLength: 50
file_name:
type: string
description: Filename to give to the rendered export file
maxLength: 200
file_extension:
type: string
description: Extension to append to the rendered filename
maxLength: 15
as_attachment:
type: boolean
description: Download file as attachment
data_source:
$ref: '#/components/schemas/BriefDataSource'
data_path:
type: string
readOnly: true
description: Path to remote file (relative to data source root)
data_file:
allOf:
- $ref: '#/components/schemas/BriefDataFile'
readOnly: true
data_synced:
type: string
format: date-time
readOnly: true
nullable: true
title: Date synced
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
required:
- created
- data_file
- data_path
- data_synced
- display
- display_url
- id
- last_updated
- name
- object_types
- template_code
- url
ClusterType:
type: object
description: Base serializer class for models inheriting from OrganizationalModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
description:
type: string
maxLength: 200
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
comments:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
custom_fields:
type: object
additionalProperties: {}
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
cluster_count:
type: integer
format: int64
readOnly: true
required:
- cluster_count
- created
- display
- display_url
- id
- last_updated
- name
- slug
- url
BriefManufacturer:
type: object
description: Base serializer class for models inheriting from OrganizationalModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
description:
type: string
maxLength: 200
required:
- display
- id
- name
- slug
- url
ClusterGroup:
type: object
description: Base serializer class for models inheriting from OrganizationalModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
description:
type: string
maxLength: 200
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
comments:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
custom_fields:
type: object
additionalProperties: {}
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
cluster_count:
type: integer
format: int64
readOnly: true
required:
- cluster_count
- created
- display
- display_url
- id
- last_updated
- name
- slug
- url
PatchedNotificationRequest:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
object_type:
type: string
object_id:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
user:
oneOf:
- type: integer
- $ref: '#/components/schemas/BriefUserRequest'
read:
type: string
format: date-time
nullable: true
event_type:
enum:
- object_created
- object_updated
- object_deleted
- job_started
- job_completed
- job_failed
- job_errored
type: string
description: '* `object_created` - Object created
* `object_updated` - Object updated
* `object_deleted` - Object deleted
* `job_started` - Job started
* `job_completed` - Job completed
* `job_failed` - Job failed
* `job_errored` - Job errored'
x-spec-enum-id: 01e557313a5c7bd2
title: Event
PaginatedNotificationList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/Notification'
BriefConfigTemplate:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
description:
type: string
maxLength: 200
required:
- display
- id
- name
- url
BriefUserRequest:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
username:
type: string
minLength: 1
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
pattern: ^[\w.@+-]+$
maxLength: 150
required:
- username
PatchedWritableEventRuleRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
object_types:
type: array
items:
type: string
name:
type: string
minLength: 1
maxLength: 150
enabled:
type: boolean
event_types:
type: array
items:
enum:
- object_created
- object_updated
- object_deleted
- job_started
- job_completed
- job_failed
- job_errored
type: string
description: '* `object_created` - Object created
* `object_updated` - Object updated
* `object_deleted` - Object deleted
* `job_started` - Job started
* `job_completed` - Job completed
* `job_failed` - Job failed
* `job_errored` - Job errored'
x-spec-enum-id: 01e557313a5c7bd2
description: The types of event which will trigger this rule.
conditions:
nullable: true
description: A set of conditions which determine whether the event will be generated.
action_type:
enum:
- webhook
- script
- notification
type: string
description: '* `webhook` - Webhook
* `script` - Script
* `notification` - Notification'
x-spec-enum-id: 287901b937995956
action_object_type:
type: string
action_object_id:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
nullable: true
description:
type: string
maxLength: 200
custom_fields:
type: object
additionalProperties: {}
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTagRequest'
CustomFieldChoiceSetRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
name:
type: string
minLength: 1
maxLength: 100
description:
type: string
maxLength: 200
base_choices:
enum:
- IATA
- ISO_3166
- UN_LOCODE
type: string
description: '* `IATA` - IATA (Airport codes)
* `ISO_3166` - ISO 3166 (Country codes)
* `UN_LOCODE` - UN/LOCODE (Location codes)'
x-spec-enum-id: cf0efb5195f85007
extra_choices:
type: array
items:
type: array
items: {}
maxItems: 2
minItems: 2
order_alphabetically:
type: boolean
description: Choices are automatically ordered alphabetically
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
required:
- extra_choices
- name
SavedFilter:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
object_types:
type: array
items:
type: string
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
description:
type: string
maxLength: 200
user:
type: integer
nullable: true
weight:
type: integer
maximum: 32767
minimum: 0
enabled:
type: boolean
shared:
type: boolean
parameters: {}
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
required:
- created
- display
- display_url
- id
- last_updated
- name
- object_types
- parameters
- slug
- url
BriefConfigContextProfile:
type: object
description: Base serializer class for models inheriting from PrimaryModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
description:
type: string
maxLength: 200
required:
- display
- id
- name
- url
PatchedTableConfigRequest:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
object_type:
type: string
table:
type: string
minLength: 1
maxLength: 100
name:
type: string
minLength: 1
maxLength: 100
description:
type: string
maxLength: 200
user:
type: integer
nullable: true
weight:
type: integer
maximum: 32767
minimum: 0
enabled:
type: boolean
shared:
type: boolean
columns:
type: array
items:
type: string
minLength: 1
maxLength: 100
ordering:
type: array
items:
type: string
minLength: 1
maxLength: 100
nullable: true
Tag:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
pattern: ^[-\w]+$
maxLength: 100
color:
type: string
pattern: ^[0-9a-f]{6}$
maxLength: 6
description:
type: string
maxLength: 200
weight:
type: integer
maximum: 32767
minimum: 0
object_types:
type: array
items:
type: string
tagged_items:
type: integer
format: int64
readOnly: true
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
required:
- created
- display
- display_url
- id
- last_updated
- name
- slug
- tagged_items
- url
NestedLocation:
type: object
description: 'Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.'
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
_depth:
type: integer
readOnly: true
title: ' depth'
required:
- _depth
- display
- display_url
- id
- name
- slug
- url
PaginatedImageAttachmentList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/ImageAttachment'
NotificationGroup:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
display_url:
type: string
format: uri
readOnly: true
name:
type: string
maxLength: 100
description:
type: string
maxLength: 200
groups:
type: array
items:
$ref: '#/components/schemas/Group'
users:
type: array
items:
$ref: '#/components/schemas/User'
required:
- display
- display_url
- id
- name
- url
ImageAttachmentRequest:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
object_type:
type: string
object_id:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
name:
type: string
maxLength: 50
image:
type: string
format: binary
description:
type: string
maxLength: 200
required:
- image
- object_id
- object_type
PatchedWritableCustomFieldChoiceSetRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
name:
type: string
minLength: 1
maxLength: 100
description:
type: string
maxLength: 200
base_choices:
enum:
- IATA
- ISO_3166
- UN_LOCODE
- ''
- null
type: string
x-spec-enum-id: cf0efb5195f85007
nullable: true
description: 'Base set of predefined choices (optional)
* `IATA` - IATA (Airport codes)
* `ISO_3166` - ISO 3166 (Country codes)
* `UN_LOCODE` - UN/LOCODE (Location codes)'
extra_choices:
type: array
items:
type: array
items: {}
maxItems: 2
minItems: 2
order_alphabetically:
type: boolean
description: Choices are automatically ordered alphabetically
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
Notification:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
object_type:
type: string
object_id:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
object:
readOnly: true
nullable: true
user:
$ref: '#/components/schemas/BriefUser'
created:
type: string
format: date-time
readOnly: true
read:
type: string
format: date-time
nullable: true
event_type:
enum:
- object_created
- object_updated
- object_deleted
- job_started
- job_completed
- job_failed
- job_errored
type: string
description: '* `object_created` - Object created
* `object_updated` - Object updated
* `object_deleted` - Object deleted
* `job_started` - Job started
* `job_completed` - Job completed
* `job_failed` - Job failed
* `job_errored` - Job errored'
x-spec-enum-id: 01e557313a5c7bd2
title: Event
required:
- created
- display
- event_type
- id
- object
- object_id
- object_type
- url
- user
PatchedBookmarkRequest:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
object_type:
type: string
object_id:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
user:
oneOf:
- type: integer
- $ref: '#/components/schemas/BriefUserRequest'
JournalEntryRequest:
type: object
description: Adds support for custom fields and tags.
properties:
assigned_object_type:
type: string
assigned_object_id:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
created_by:
type: integer
nullable: true
kind:
enum:
- info
- success
- warning
- danger
type: string
description: '* `info` - Info
* `success` - Success
* `warning` - Warning
* `danger` - Danger'
x-spec-enum-id: 6f65abe0aab2c78c
comments:
type: string
minLength: 1
tags:
type: array
items:
$ref: '#/components/schemas/NestedTagRequest'
custom_fields:
type: object
additionalProperties: {}
required:
- assigned_object_id
- assigned_object_type
- comments
BriefCustomFieldChoiceSet:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
description:
type: string
maxLength: 200
choices_count:
type: integer
readOnly: true
required:
- choices_count
- display
- id
- name
- url
ConfigTemplateRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
name:
type: string
minLength: 1
maxLength: 100
description:
type: string
maxLength: 200
environment_params:
nullable: true
title: Environment parameters
description: Any additional parameters to pass when constructing the Jinja environment
template_code:
type: string
minLength: 1
description: Jinja template code.
mime_type:
type: string
description: Defaults to text/plain; charset=utf-8
maxLength: 50
file_name:
type: string
description: Filename to give to the rendered export file
maxLength: 200
file_extension:
type: string
description: Extension to append to the rendered filename
maxLength: 15
as_attachment:
type: boolean
description: Download file as attachment
data_source:
oneOf:
- type: integer
- $ref: '#/components/schemas/BriefDataSourceRequest'
auto_sync_enabled:
type: boolean
description: Enable automatic synchronization of data when the data file is updated
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTagRequest'
required:
- name
- template_code
Region:
type: object
description: Base serializer class for models inheriting from NestedGroupModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
parent:
allOf:
- $ref: '#/components/schemas/NestedRegion'
nullable: true
description:
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
custom_fields:
type: object
additionalProperties: {}
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
site_count:
type: integer
readOnly: true
default: 0
prefix_count:
type: integer
format: int64
readOnly: true
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
comments:
type: string
_depth:
type: integer
readOnly: true
title: ' depth'
required:
- _depth
- created
- display
- display_url
- id
- last_updated
- name
- prefix_count
- site_count
- slug
- url
CustomFieldRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
object_types:
type: array
items:
type: string
type:
enum:
- text
- longtext
- integer
- decimal
- boolean
- date
- datetime
- url
- json
- select
- multiselect
- object
- multiobject
type: string
description: '* `text` - Text
* `longtext` - Text (long)
* `integer` - Integer
* `decimal` - Decimal
* `boolean` - Boolean (true/false)
* `date` - Date
* `datetime` - Date & time
* `url` - URL
* `json` - JSON
* `select` - Selection
* `multiselect` - Multiple selection
* `object` - Object
* `multiobject` - Multiple objects'
x-spec-enum-id: 47c52a3d983e924c
related_object_type:
type: string
nullable: true
name:
type: string
minLength: 1
description: Internal field name
pattern: ^[a-z0-9_]+$
maxLength: 50
label:
type: string
description: Name of the field as displayed to users (if not provided, 'the field's name will be used)
maxLength: 50
group_name:
type: string
description: Custom fields within the same group will be displayed together
maxLength: 50
description:
type: string
maxLength: 200
required:
type: boolean
description: This field is required when creating new objects or editing an existing object.
unique:
type: boolean
title: Must be unique
description: The value of this field must be unique for the assigned object
search_weight:
type: integer
maximum: 32767
minimum: 0
description: Weighting for search. Lower values are considered more important. Fields with a search weight of zero will be ignored.
filter_logic:
enum:
- disabled
- loose
- exact
type: string
description: '* `disabled` - Disabled
* `loose` - Loose
* `exact` - Exact'
x-spec-enum-id: d168820c798ae45a
ui_visible:
enum:
- always
- if-set
- hidden
type: string
description: '* `always` - Always
* `if-set` - If set
* `hidden` - Hidden'
x-spec-enum-id: f32800c399b927b6
ui_editable:
enum:
- 'yes'
- 'no'
- hidden
type: string
description: '* `yes` - Yes
* `no` - No
* `hidden` - Hidden'
x-spec-enum-id: 336f52760e62022f
is_cloneable:
type: boolean
description: Replicate this value when cloning objects
default:
nullable: true
description: Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. "Foo").
related_object_filter:
nullable: true
description: Filter the object selection choices using a query_params dict (must be a JSON value).Encapsulate strings with double quotes (e.g. "Foo").
weight:
type: integer
maximum: 32767
minimum: 0
title: Display weight
description: Fields with higher weights appear lower in a form.
validation_minimum:
type: number
format: double
maximum: 1000000000000
minimum: -1000000000000
exclusiveMaximum: true
exclusiveMinimum: true
nullable: true
title: Minimum value
description: Minimum allowed value (for numeric fields)
validation_maximum:
type: number
format: double
maximum: 1000000000000
minimum: -1000000000000
exclusiveMaximum: true
exclusiveMinimum: true
nullable: true
title: Maximum value
description: Maximum allowed value (for numeric fields)
validation_regex:
type: string
description: Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, ^[A-Z]{3}$ will limit values to exactly three uppercase letters.
maxLength: 500
choice_set:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefCustomFieldChoiceSetRequest'
nullable: true
nullable: true
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
comments:
type: string
required:
- name
- object_types
- type
WritableJournalEntryRequest:
type: object
description: Adds support for custom fields and tags.
properties:
assigned_object_type:
type: string
assigned_object_id:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
created_by:
type: integer
nullable: true
kind:
enum:
- info
- success
- warning
- danger
type: string
description: '* `info` - Info
* `success` - Success
* `warning` - Warning
* `danger` - Danger'
x-spec-enum-id: 6f65abe0aab2c78c
comments:
type: string
minLength: 1
tags:
type: array
items:
$ref: '#/components/schemas/NestedTagRequest'
custom_fields:
type: object
additionalProperties: {}
required:
- assigned_object_id
- assigned_object_type
- comments
BriefOwner:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
description:
type: string
maxLength: 200
required:
- display
- id
- name
- url
User:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
username:
type: string
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
pattern: ^[\w.@+-]+$
maxLength: 150
first_name:
type: string
maxLength: 150
last_name:
type: string
maxLength: 150
email:
type: string
format: email
title: Email address
maxLength: 254
is_active:
type: boolean
title: Active
description: Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
date_joined:
type: string
format: date-time
last_login:
type: string
format: date-time
nullable: true
groups:
type: array
items:
$ref: '#/components/schemas/Group'
permissions:
type: array
items:
$ref: '#/components/schemas/ObjectPermission'
required:
- display
- display_url
- id
- url
- username
Bookmark:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
object_type:
type: string
object_id:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
object:
readOnly: true
nullable: true
user:
$ref: '#/components/schemas/BriefUser'
created:
type: string
format: date-time
readOnly: true
required:
- created
- display
- id
- object
- object_id
- object_type
- url
- user
PatchedWebhookRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
name:
type: string
minLength: 1
maxLength: 150
description:
type: string
maxLength: 200
payload_url:
type: string
minLength: 1
title: URL
description: This URL will be called using the HTTP method defined when the webhook is called. Jinja2 template processing is supported with the same context as the request body.
maxLength: 500
http_method:
enum:
- GET
- POST
- PUT
- PATCH
- DELETE
type: string
description: '* `GET` - GET
* `POST` - POST
* `PUT` - PUT
* `PATCH` - PATCH
* `DELETE` - DELETE'
x-spec-enum-id: 867bf764d3b1eeaa
http_content_type:
type: string
minLength: 1
description: The complete list of official content types is available here.
maxLength: 100
additional_headers:
type: string
description: 'User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format Name: Value. Jinja2 template processing is supported with the same context as the request body (below).'
body_template:
type: string
description: 'Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: event, model, timestamp, username, request_id, and data.'
secret:
type: string
description: When provided, the request will include a X-Hook-Signature header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request.
maxLength: 255
ssl_verification:
type: boolean
description: Enable SSL certificate verification. Disable with caution!
ca_file_path:
type: string
nullable: true
description: The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults.
maxLength: 4096
custom_fields:
type: object
additionalProperties: {}
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTagRequest'
ConfigContext:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
weight:
type: integer
maximum: 32767
minimum: 0
profile:
allOf:
- $ref: '#/components/schemas/BriefConfigContextProfile'
nullable: true
description:
type: string
maxLength: 200
is_active:
type: boolean
regions:
type: array
items:
$ref: '#/components/schemas/Region'
site_groups:
type: array
items:
$ref: '#/components/schemas/SiteGroup'
sites:
type: array
items:
$ref: '#/components/schemas/Site'
locations:
type: array
items:
$ref: '#/components/schemas/Location'
device_types:
type: array
items:
$ref: '#/components/schemas/DeviceType'
roles:
type: array
items:
$ref: '#/components/schemas/DeviceRole'
platforms:
type: array
items:
$ref: '#/components/schemas/Platform'
cluster_types:
type: array
items:
$ref: '#/components/schemas/ClusterType'
cluster_groups:
type: array
items:
$ref: '#/components/schemas/ClusterGroup'
clusters:
type: array
items:
$ref: '#/components/schemas/Cluster'
tenant_groups:
type: array
items:
$ref: '#/components/schemas/TenantGroup'
tenants:
type: array
items:
$ref: '#/components/schemas/Tenant'
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
tags:
type: array
items:
type: string
data_source:
$ref: '#/components/schemas/BriefDataSource'
data_path:
type: string
readOnly: true
description: Path to remote file (relative to data source root)
data_file:
$ref: '#/components/schemas/BriefDataFile'
data_synced:
type: string
format: date-time
readOnly: true
nullable: true
title: Date synced
data: {}
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
required:
- created
- data
- data_path
- data_synced
- display
- display_url
- id
- last_updated
- name
- url
PatchedWritableCustomFieldRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
object_types:
type: array
items:
type: string
type:
enum:
- text
- longtext
- integer
- decimal
- boolean
- date
- datetime
- url
- json
- select
- multiselect
- object
- multiobject
type: string
x-spec-enum-id: 47c52a3d983e924c
description: 'The type of data this custom field holds
* `text` - Text
* `longtext` - Text (long)
* `integer` - Integer
* `decimal` - Decimal
* `boolean` - Boolean (true/false)
* `date` - Date
* `datetime` - Date & time
* `url` - URL
* `json` - JSON
* `select` - Selection
* `multiselect` - Multiple selection
* `object` - Object
* `multiobject` - Multiple objects'
related_object_type:
type: string
nullable: true
name:
type: string
minLength: 1
description: Internal field name
pattern: ^[a-z0-9_]+$
maxLength: 50
label:
type: string
description: Name of the field as displayed to users (if not provided, 'the field's name will be used)
maxLength: 50
group_name:
type: string
description: Custom fields within the same group will be displayed together
maxLength: 50
description:
type: string
maxLength: 200
required:
type: boolean
description: This field is required when creating new objects or editing an existing object.
unique:
type: boolean
title: Must be unique
description: The value of this field must be unique for the assigned object
search_weight:
type: integer
maximum: 32767
minimum: 0
description: Weighting for search. Lower values are considered more important. Fields with a search weight of zero will be ignored.
filter_logic:
enum:
- disabled
- loose
- exact
type: string
x-spec-enum-id: d168820c798ae45a
description: 'Loose matches any instance of a given string; exact matches the entire field.
* `disabled` - Disabled
* `loose` - Loose
* `exact` - Exact'
ui_visible:
enum:
- always
- if-set
- hidden
type: string
x-spec-enum-id: f32800c399b927b6
description: 'Specifies whether the custom field is displayed in the UI
* `always` - Always
* `if-set` - If set
* `hidden` - Hidden'
ui_editable:
enum:
- 'yes'
- 'no'
- hidden
type: string
x-spec-enum-id: 336f52760e62022f
description: 'Specifies whether the custom field value can be edited in the UI
* `yes` - Yes
* `no` - No
* `hidden` - Hidden'
is_cloneable:
type: boolean
description: Replicate this value when cloning objects
default:
nullable: true
description: Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. "Foo").
related_object_filter:
nullable: true
description: Filter the object selection choices using a query_params dict (must be a JSON value).Encapsulate strings with double quotes (e.g. "Foo").
weight:
type: integer
maximum: 32767
minimum: 0
title: Display weight
description: Fields with higher weights appear lower in a form.
validation_minimum:
type: number
format: double
maximum: 1000000000000
minimum: -1000000000000
exclusiveMaximum: true
exclusiveMinimum: true
nullable: true
title: Minimum value
description: Minimum allowed value (for numeric fields)
validation_maximum:
type: number
format: double
maximum: 1000000000000
minimum: -1000000000000
exclusiveMaximum: true
exclusiveMinimum: true
nullable: true
title: Maximum value
description: Maximum allowed value (for numeric fields)
validation_regex:
type: string
description: Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, ^[A-Z]{3}$ will limit values to exactly three uppercase letters.
maxLength: 500
choice_set:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefCustomFieldChoiceSetRequest'
nullable: true
nullable: true
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
comments:
type: string
SiteGroup:
type: object
description: Base serializer class for models inheriting from NestedGroupModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
parent:
allOf:
- $ref: '#/components/schemas/NestedSiteGroup'
nullable: true
description:
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
custom_fields:
type: object
additionalProperties: {}
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
site_count:
type: integer
readOnly: true
default: 0
prefix_count:
type: integer
format: int64
readOnly: true
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
comments:
type: string
_depth:
type: integer
readOnly: true
title: ' depth'
required:
- _depth
- created
- display
- display_url
- id
- last_updated
- name
- prefix_count
- site_count
- slug
- url
WritableCustomFieldChoiceSetRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
name:
type: string
minLength: 1
maxLength: 100
description:
type: string
maxLength: 200
base_choices:
enum:
- IATA
- ISO_3166
- UN_LOCODE
- ''
- null
type: string
x-spec-enum-id: cf0efb5195f85007
nullable: true
description: 'Base set of predefined choices (optional)
* `IATA` - IATA (Airport codes)
* `ISO_3166` - ISO 3166 (Country codes)
* `UN_LOCODE` - UN/LOCODE (Location codes)'
extra_choices:
type: array
items:
type: array
items: {}
maxItems: 2
minItems: 2
order_alphabetically:
type: boolean
description: Choices are automatically ordered alphabetically
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
required:
- extra_choices
- name
PaginatedExportTemplateList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/ExportTemplate'
PaginatedScriptList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/Script'
PaginatedSubscriptionList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/Subscription'
NestedTenantGroup:
type: object
description: 'Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.'
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
_depth:
type: integer
readOnly: true
title: ' depth'
required:
- _depth
- display
- display_url
- id
- name
- slug
- url
PatchedDashboardRequest:
type: object
properties:
layout: {}
config: {}
Webhook:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 150
description:
type: string
maxLength: 200
payload_url:
type: string
title: URL
description: This URL will be called using the HTTP method defined when the webhook is called. Jinja2 template processing is supported with the same context as the request body.
maxLength: 500
http_method:
enum:
- GET
- POST
- PUT
- PATCH
- DELETE
type: string
description: '* `GET` - GET
* `POST` - POST
* `PUT` - PUT
* `PATCH` - PATCH
* `DELETE` - DELETE'
x-spec-enum-id: 867bf764d3b1eeaa
http_content_type:
type: string
description: The complete list of official content types is available here.
maxLength: 100
additional_headers:
type: string
description: 'User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format Name: Value. Jinja2 template processing is supported with the same context as the request body (below).'
body_template:
type: string
description: 'Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: event, model, timestamp, username, request_id, and data.'
secret:
type: string
description: When provided, the request will include a X-Hook-Signature header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request.
maxLength: 255
ssl_verification:
type: boolean
description: Enable SSL certificate verification. Disable with caution!
ca_file_path:
type: string
nullable: true
description: The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults.
maxLength: 4096
custom_fields:
type: object
additionalProperties: {}
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
required:
- created
- display
- display_url
- id
- last_updated
- name
- payload_url
- url
PatchedWritableJournalEntryRequest:
type: object
description: Adds support for custom fields and tags.
properties:
assigned_object_type:
type: string
assigned_object_id:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
created_by:
type: integer
nullable: true
kind:
enum:
- info
- success
- warning
- danger
type: string
description: '* `info` - Info
* `success` - Success
* `warning` - Warning
* `danger` - Danger'
x-spec-enum-id: 6f65abe0aab2c78c
comments:
type: string
minLength: 1
tags:
type: array
items:
$ref: '#/components/schemas/NestedTagRequest'
custom_fields:
type: object
additionalProperties: {}
Dashboard:
type: object
properties:
layout: {}
config: {}
CustomFieldChoiceSet:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
description:
type: string
maxLength: 200
base_choices:
type: object
properties:
value:
enum:
- IATA
- ISO_3166
- UN_LOCODE
type: string
description: '* `IATA` - IATA (Airport codes)
* `ISO_3166` - ISO 3166 (Country codes)
* `UN_LOCODE` - UN/LOCODE (Location codes)'
x-spec-enum-id: cf0efb5195f85007
label:
type: string
enum:
- IATA (Airport codes)
- ISO 3166 (Country codes)
- UN/LOCODE (Location codes)
extra_choices:
type: array
items:
type: array
items: {}
maxItems: 2
minItems: 2
order_alphabetically:
type: boolean
description: Choices are automatically ordered alphabetically
choices_count:
type: integer
readOnly: true
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
required:
- choices_count
- created
- display
- display_url
- extra_choices
- id
- last_updated
- name
- url
WebhookRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
name:
type: string
minLength: 1
maxLength: 150
description:
type: string
maxLength: 200
payload_url:
type: string
minLength: 1
title: URL
description: This URL will be called using the HTTP method defined when the webhook is called. Jinja2 template processing is supported with the same context as the request body.
maxLength: 500
http_method:
enum:
- GET
- POST
- PUT
- PATCH
- DELETE
type: string
description: '* `GET` - GET
* `POST` - POST
* `PUT` - PUT
* `PATCH` - PATCH
* `DELETE` - DELETE'
x-spec-enum-id: 867bf764d3b1eeaa
http_content_type:
type: string
minLength: 1
description: The complete list of official content types is available here.
maxLength: 100
additional_headers:
type: string
description: 'User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format Name: Value. Jinja2 template processing is supported with the same context as the request body (below).'
body_template:
type: string
description: 'Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: event, model, timestamp, username, request_id, and data.'
secret:
type: string
description: When provided, the request will include a X-Hook-Signature header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request.
maxLength: 255
ssl_verification:
type: boolean
description: Enable SSL certificate verification. Disable with caution!
ca_file_path:
type: string
nullable: true
description: The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults.
maxLength: 4096
custom_fields:
type: object
additionalProperties: {}
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTagRequest'
required:
- name
- payload_url
PaginatedTagList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/Tag'
BriefDataSourceRequest:
type: object
description: Base serializer class for models inheriting from PrimaryModel.
properties:
name:
type: string
minLength: 1
maxLength: 100
description:
type: string
maxLength: 200
required:
- name
CustomField:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
object_types:
type: array
items:
type: string
type:
type: object
properties:
value:
enum:
- text
- longtext
- integer
- decimal
- boolean
- date
- datetime
- url
- json
- select
- multiselect
- object
- multiobject
type: string
description: '* `text` - Text
* `longtext` - Text (long)
* `integer` - Integer
* `decimal` - Decimal
* `boolean` - Boolean (true/false)
* `date` - Date
* `datetime` - Date & time
* `url` - URL
* `json` - JSON
* `select` - Selection
* `multiselect` - Multiple selection
* `object` - Object
* `multiobject` - Multiple objects'
x-spec-enum-id: 47c52a3d983e924c
label:
type: string
enum:
- Text
- Text (long)
- Integer
- Decimal
- Boolean (true/false)
- Date
- Date & time
- URL
- JSON
- Selection
- Multiple selection
- Object
- Multiple objects
related_object_type:
type: string
nullable: true
data_type:
type: string
readOnly: true
name:
type: string
description: Internal field name
pattern: ^[a-z0-9_]+$
maxLength: 50
label:
type: string
description: Name of the field as displayed to users (if not provided, 'the field's name will be used)
maxLength: 50
group_name:
type: string
description: Custom fields within the same group will be displayed together
maxLength: 50
description:
type: string
maxLength: 200
required:
type: boolean
description: This field is required when creating new objects or editing an existing object.
unique:
type: boolean
title: Must be unique
description: The value of this field must be unique for the assigned object
search_weight:
type: integer
maximum: 32767
minimum: 0
description: Weighting for search. Lower values are considered more important. Fields with a search weight of zero will be ignored.
filter_logic:
type: object
properties:
value:
enum:
- disabled
- loose
- exact
type: string
description: '* `disabled` - Disabled
* `loose` - Loose
* `exact` - Exact'
x-spec-enum-id: d168820c798ae45a
label:
type: string
enum:
- Disabled
- Loose
- Exact
ui_visible:
type: object
properties:
value:
enum:
- always
- if-set
- hidden
type: string
description: '* `always` - Always
* `if-set` - If set
* `hidden` - Hidden'
x-spec-enum-id: f32800c399b927b6
label:
type: string
enum:
- Always
- If set
- Hidden
ui_editable:
type: object
properties:
value:
enum:
- 'yes'
- 'no'
- hidden
type: string
description: '* `yes` - Yes
* `no` - No
* `hidden` - Hidden'
x-spec-enum-id: 336f52760e62022f
label:
type: string
enum:
- 'Yes'
- 'No'
- Hidden
is_cloneable:
type: boolean
description: Replicate this value when cloning objects
default:
nullable: true
description: Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. "Foo").
related_object_filter:
nullable: true
description: Filter the object selection choices using a query_params dict (must be a JSON value).Encapsulate strings with double quotes (e.g. "Foo").
weight:
type: integer
maximum: 32767
minimum: 0
title: Display weight
description: Fields with higher weights appear lower in a form.
validation_minimum:
type: number
format: double
maximum: 1000000000000
minimum: -1000000000000
exclusiveMaximum: true
exclusiveMinimum: true
nullable: true
title: Minimum value
description: Minimum allowed value (for numeric fields)
validation_maximum:
type: number
format: double
maximum: 1000000000000
minimum: -1000000000000
exclusiveMaximum: true
exclusiveMinimum: true
nullable: true
title: Maximum value
description: Maximum allowed value (for numeric fields)
validation_regex:
type: string
description: Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, ^[A-Z]{3}$ will limit values to exactly three uppercase letters.
maxLength: 500
choice_set:
allOf:
- $ref: '#/components/schemas/BriefCustomFieldChoiceSet'
nullable: true
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
comments:
type: string
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
required:
- created
- data_type
- display
- display_url
- id
- last_updated
- name
- object_types
- type
- url
DeviceRole:
type: object
description: Base serializer class for models inheriting from NestedGroupModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
color:
type: string
pattern: ^[0-9a-f]{6}$
maxLength: 6
vm_role:
type: boolean
description: Virtual machines may be assigned to this role
config_template:
allOf:
- $ref: '#/components/schemas/BriefConfigTemplate'
nullable: true
parent:
allOf:
- $ref: '#/components/schemas/NestedDeviceRole'
nullable: true
description:
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
custom_fields:
type: object
additionalProperties: {}
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
device_count:
type: integer
readOnly: true
default: 0
virtualmachine_count:
type: integer
readOnly: true
default: 0
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
comments:
type: string
_depth:
type: integer
readOnly: true
title: ' depth'
required:
- _depth
- created
- device_count
- display
- display_url
- id
- last_updated
- name
- slug
- url
- virtualmachine_count
BriefConfigContextProfileRequest:
type: object
description: Base serializer class for models inheriting from PrimaryModel.
properties:
name:
type: string
minLength: 1
maxLength: 100
description:
type: string
maxLength: 200
required:
- name
Script:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
module:
type: integer
readOnly: true
name:
type: string
readOnly: true
description:
type: string
nullable: true
readOnly: true
vars:
nullable: true
readOnly: true
result:
allOf:
- $ref: '#/components/schemas/BriefJob'
readOnly: true
display:
type: string
readOnly: true
is_executable:
type: boolean
readOnly: true
required:
- description
- display
- display_url
- id
- is_executable
- module
- name
- result
- url
- vars
TaggedItem:
type: object
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
object_type:
type: string
readOnly: true
object_id:
type: integer
maximum: 2147483647
minimum: -2147483648
object:
readOnly: true
tag:
allOf:
- $ref: '#/components/schemas/BriefTag'
readOnly: true
required:
- display
- id
- object
- object_id
- object_type
- tag
- url
PaginatedBookmarkList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/Bookmark'
ScriptModule:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
id:
type: integer
readOnly: true
display:
type: string
readOnly: true
file_path:
type: string
readOnly: true
created:
type: string
format: date-time
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
required:
- created
- display
- file_path
- id
- last_updated
ObjectPermission:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
description:
type: string
maxLength: 200
enabled:
type: boolean
object_types:
type: array
items:
type: string
actions:
type: array
items:
type: string
maxLength: 30
description: The list of actions granted by this permission
constraints:
nullable: true
description: Queryset filter matching the applicable objects of the selected type(s)
groups:
type: array
items:
$ref: '#/components/schemas/NestedGroup'
users:
type: array
items:
$ref: '#/components/schemas/NestedUser'
required:
- actions
- display
- display_url
- id
- name
- object_types
- url
BriefOwnerRequest:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
name:
type: string
minLength: 1
maxLength: 100
description:
type: string
maxLength: 200
required:
- name
BriefClusterGroup:
type: object
description: Base serializer class for models inheriting from OrganizationalModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
description:
type: string
maxLength: 200
cluster_count:
type: integer
format: int64
readOnly: true
required:
- cluster_count
- display
- id
- name
- slug
- url
ConfigContextProfileRequest:
type: object
description: Base serializer class for models inheriting from PrimaryModel.
properties:
name:
type: string
minLength: 1
maxLength: 100
description:
type: string
maxLength: 200
schema:
nullable: true
description: A JSON schema specifying the structure of the context data for this profile
tags:
type: array
items:
$ref: '#/components/schemas/NestedTagRequest'
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
comments:
type: string
data_source:
oneOf:
- type: integer
- $ref: '#/components/schemas/BriefDataSourceRequest'
required:
- name
BriefSite:
type: object
description: Base serializer class for models inheriting from PrimaryModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
description: Full name of the site
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
description:
type: string
maxLength: 200
required:
- display
- id
- name
- slug
- url
BriefTag:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
pattern: ^[-\w]+$
maxLength: 100
color:
type: string
pattern: ^[0-9a-f]{6}$
maxLength: 6
description:
type: string
maxLength: 200
required:
- display
- id
- name
- slug
- url
BriefDataSource:
type: object
description: Base serializer class for models inheriting from PrimaryModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
description:
type: string
maxLength: 200
required:
- display
- id
- name
- url
ConfigTemplate:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
description:
type: string
maxLength: 200
environment_params:
nullable: true
title: Environment parameters
description: Any additional parameters to pass when constructing the Jinja environment
template_code:
type: string
description: Jinja template code.
mime_type:
type: string
description: Defaults to text/plain; charset=utf-8
maxLength: 50
file_name:
type: string
description: Filename to give to the rendered export file
maxLength: 200
file_extension:
type: string
description: Extension to append to the rendered filename
maxLength: 15
as_attachment:
type: boolean
description: Download file as attachment
data_source:
$ref: '#/components/schemas/BriefDataSource'
data_path:
type: string
readOnly: true
description: Path to remote file (relative to data source root)
data_file:
$ref: '#/components/schemas/BriefDataFile'
auto_sync_enabled:
type: boolean
description: Enable automatic synchronization of data when the data file is updated
data_synced:
type: string
format: date-time
readOnly: true
nullable: true
title: Date synced
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
required:
- created
- data_path
- data_synced
- display
- display_url
- id
- last_updated
- name
- template_code
- url
Group:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 150
description:
type: string
maxLength: 200
permissions:
type: array
items:
$ref: '#/components/schemas/ObjectPermission'
user_count:
type: integer
readOnly: true
required:
- display
- display_url
- id
- name
- url
- user_count
NotificationGroupRequest:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
name:
type: string
minLength: 1
maxLength: 100
description:
type: string
maxLength: 200
groups:
type: array
items:
type: integer
users:
type: array
items:
type: integer
required:
- name
PatchedCustomLinkRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
object_types:
type: array
items:
type: string
name:
type: string
minLength: 1
maxLength: 100
enabled:
type: boolean
link_text:
type: string
minLength: 1
description: Jinja2 template code for link text
link_url:
type: string
minLength: 1
description: Jinja2 template code for link URL
weight:
type: integer
maximum: 32767
minimum: 0
group_name:
type: string
description: Links with the same group will appear as a dropdown menu
maxLength: 50
button_class:
enum:
- default
- blue
- indigo
- purple
- pink
- red
- orange
- yellow
- green
- teal
- cyan
- gray
- black
- white
- ghost-dark
type: string
x-spec-enum-id: 5e54b3bd086685ce
description: 'The class of the first link in a group will be used for the dropdown button
* `default` - Default
* `blue` - Blue
* `indigo` - Indigo
* `purple` - Purple
* `pink` - Pink
* `red` - Red
* `orange` - Orange
* `yellow` - Yellow
* `green` - Green
* `teal` - Teal
* `cyan` - Cyan
* `gray` - Gray
* `black` - Black
* `white` - White
* `ghost-dark` - Link'
new_window:
type: boolean
description: Force link to open in a new window
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
PatchedTagRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
name:
type: string
minLength: 1
maxLength: 100
slug:
type: string
minLength: 1
pattern: ^[-\w]+$
maxLength: 100
color:
type: string
minLength: 1
pattern: ^[0-9a-f]{6}$
maxLength: 6
description:
type: string
maxLength: 200
weight:
type: integer
maximum: 32767
minimum: 0
object_types:
type: array
items:
type: string
ConfigContextProfile:
type: object
description: Base serializer class for models inheriting from PrimaryModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
description:
type: string
maxLength: 200
schema:
nullable: true
description: A JSON schema specifying the structure of the context data for this profile
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
comments:
type: string
data_source:
$ref: '#/components/schemas/BriefDataSource'
data_path:
type: string
readOnly: true
description: Path to remote file (relative to data source root)
data_file:
$ref: '#/components/schemas/BriefDataFile'
data_synced:
type: string
format: date-time
readOnly: true
nullable: true
title: Date synced
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
required:
- created
- data_path
- data_synced
- display
- display_url
- id
- last_updated
- name
- url
PatchedNotificationGroupRequest:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
name:
type: string
minLength: 1
maxLength: 100
description:
type: string
maxLength: 200
groups:
type: array
items:
type: integer
users:
type: array
items:
type: integer
PaginatedConfigTemplateList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/ConfigTemplate'
PaginatedConfigContextList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/ConfigContext'
PaginatedTaggedItemList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/TaggedItem'
CustomLinkRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
object_types:
type: array
items:
type: string
name:
type: string
minLength: 1
maxLength: 100
enabled:
type: boolean
link_text:
type: string
minLength: 1
description: Jinja2 template code for link text
link_url:
type: string
minLength: 1
description: Jinja2 template code for link URL
weight:
type: integer
maximum: 32767
minimum: 0
group_name:
type: string
description: Links with the same group will appear as a dropdown menu
maxLength: 50
button_class:
enum:
- default
- blue
- indigo
- purple
- pink
- red
- orange
- yellow
- green
- teal
- cyan
- gray
- black
- white
- ghost-dark
type: string
x-spec-enum-id: 5e54b3bd086685ce
description: 'The class of the first link in a group will be used for the dropdown button
* `default` - Default
* `blue` - Blue
* `indigo` - Indigo
* `purple` - Purple
* `pink` - Pink
* `red` - Red
* `orange` - Orange
* `yellow` - Yellow
* `green` - Green
* `teal` - Teal
* `cyan` - Cyan
* `gray` - Gray
* `black` - Black
* `white` - White
* `ghost-dark` - Link'
new_window:
type: boolean
description: Force link to open in a new window
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
required:
- link_text
- link_url
- name
- object_types
EventRule:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
object_types:
type: array
items:
type: string
name:
type: string
maxLength: 150
enabled:
type: boolean
event_types:
type: array
items:
enum:
- object_created
- object_updated
- object_deleted
- job_started
- job_completed
- job_failed
- job_errored
type: string
description: '* `object_created` - Object created
* `object_updated` - Object updated
* `object_deleted` - Object deleted
* `job_started` - Job started
* `job_completed` - Job completed
* `job_failed` - Job failed
* `job_errored` - Job errored'
x-spec-enum-id: 01e557313a5c7bd2
description: The types of event which will trigger this rule.
conditions:
nullable: true
description: A set of conditions which determine whether the event will be generated.
action_type:
type: object
properties:
value:
enum:
- webhook
- script
- notification
type: string
description: '* `webhook` - Webhook
* `script` - Script
* `notification` - Notification'
x-spec-enum-id: 287901b937995956
label:
type: string
enum:
- Webhook
- Script
- Notification
action_object_type:
type: string
action_object_id:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
nullable: true
action_object:
readOnly: true
nullable: true
description:
type: string
maxLength: 200
custom_fields:
type: object
additionalProperties: {}
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
required:
- action_object
- action_object_type
- action_type
- created
- display
- display_url
- event_types
- id
- last_updated
- name
- object_types
- url
Tenant:
type: object
description: Base serializer class for models inheriting from PrimaryModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
group:
allOf:
- $ref: '#/components/schemas/BriefTenantGroup'
nullable: true
description:
type: string
maxLength: 200
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
comments:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
custom_fields:
type: object
additionalProperties: {}
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
circuit_count:
type: integer
format: int64
readOnly: true
device_count:
type: integer
format: int64
readOnly: true
ipaddress_count:
type: integer
format: int64
readOnly: true
prefix_count:
type: integer
format: int64
readOnly: true
rack_count:
type: integer
format: int64
readOnly: true
site_count:
type: integer
format: int64
readOnly: true
virtualmachine_count:
type: integer
format: int64
readOnly: true
vlan_count:
type: integer
format: int64
readOnly: true
vrf_count:
type: integer
format: int64
readOnly: true
cluster_count:
type: integer
format: int64
readOnly: true
required:
- circuit_count
- cluster_count
- created
- device_count
- display
- display_url
- id
- ipaddress_count
- last_updated
- name
- prefix_count
- rack_count
- site_count
- slug
- url
- virtualmachine_count
- vlan_count
- vrf_count
Cluster:
type: object
description: Base serializer class for models inheriting from PrimaryModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
type:
$ref: '#/components/schemas/BriefClusterType'
group:
allOf:
- $ref: '#/components/schemas/BriefClusterGroup'
nullable: true
status:
type: object
properties:
value:
enum:
- planned
- staging
- active
- decommissioning
- offline
type: string
description: '* `planned` - Planned
* `staging` - Staging
* `active` - Active
* `decommissioning` - Decommissioning
* `offline` - Offline'
x-spec-enum-id: 65a25166053759eb
label:
type: string
enum:
- Planned
- Staging
- Active
- Decommissioning
- Offline
tenant:
allOf:
- $ref: '#/components/schemas/BriefTenant'
nullable: true
scope_type:
type: string
nullable: true
scope_id:
type: integer
nullable: true
scope:
readOnly: true
nullable: true
description:
type: string
maxLength: 200
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
comments:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
custom_fields:
type: object
additionalProperties: {}
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
device_count:
type: integer
format: int64
readOnly: true
virtualmachine_count:
type: integer
format: int64
readOnly: true
allocated_vcpus:
type: number
format: double
maximum: 1000000
minimum: -1000000
exclusiveMaximum: true
exclusiveMinimum: true
readOnly: true
allocated_memory:
type: integer
readOnly: true
allocated_disk:
type: integer
readOnly: true
required:
- allocated_disk
- allocated_memory
- allocated_vcpus
- created
- device_count
- display
- display_url
- id
- last_updated
- name
- scope
- type
- url
- virtualmachine_count
PaginatedWebhookList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/Webhook'
NestedGroup:
type: object
description: 'Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.'
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 150
required:
- display
- display_url
- id
- name
- url
ConfigContextRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
name:
type: string
minLength: 1
maxLength: 100
weight:
type: integer
maximum: 32767
minimum: 0
profile:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefConfigContextProfileRequest'
nullable: true
nullable: true
description:
type: string
maxLength: 200
is_active:
type: boolean
regions:
type: array
items:
type: integer
site_groups:
type: array
items:
type: integer
sites:
type: array
items:
type: integer
locations:
type: array
items:
type: integer
device_types:
type: array
items:
type: integer
roles:
type: array
items:
type: integer
platforms:
type: array
items:
type: integer
cluster_types:
type: array
items:
type: integer
cluster_groups:
type: array
items:
type: integer
clusters:
type: array
items:
type: integer
tenant_groups:
type: array
items:
type: integer
tenants:
type: array
items:
type: integer
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
tags:
type: array
items:
type: string
minLength: 1
data_source:
oneOf:
- type: integer
- $ref: '#/components/schemas/BriefDataSourceRequest'
data: {}
required:
- data
- name
BriefRegion:
type: object
description: Base serializer class for models inheriting from NestedGroupModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
description:
type: string
maxLength: 200
site_count:
type: integer
readOnly: true
default: 0
_depth:
type: integer
readOnly: true
title: ' depth'
required:
- _depth
- display
- id
- name
- site_count
- slug
- url
BriefClusterType:
type: object
description: Base serializer class for models inheriting from OrganizationalModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
description:
type: string
maxLength: 200
cluster_count:
type: integer
format: int64
readOnly: true
required:
- cluster_count
- display
- id
- name
- slug
- url
BriefJob:
type: object
properties:
url:
type: string
format: uri
readOnly: true
status:
type: object
properties:
value:
enum:
- pending
- scheduled
- running
- completed
- errored
- failed
type: string
description: '* `pending` - Pending
* `scheduled` - Scheduled
* `running` - Running
* `completed` - Completed
* `errored` - Errored
* `failed` - Failed'
x-spec-enum-id: b3049df95b935eab
label:
type: string
enum:
- Pending
- Scheduled
- Running
- Completed
- Errored
- Failed
readOnly: true
created:
type: string
format: date-time
readOnly: true
completed:
type: string
format: date-time
nullable: true
user:
allOf:
- $ref: '#/components/schemas/BriefUser'
readOnly: true
required:
- created
- status
- url
- user
PaginatedCustomLinkList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/CustomLink'
PatchedConfigTemplateRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
name:
type: string
minLength: 1
maxLength: 100
description:
type: string
maxLength: 200
environment_params:
nullable: true
title: Environment parameters
description: Any additional parameters to pass when constructing the Jinja environment
template_code:
type: string
minLength: 1
description: Jinja template code.
mime_type:
type: string
description: Defaults to text/plain; charset=utf-8
maxLength: 50
file_name:
type: string
description: Filename to give to the rendered export file
maxLength: 200
file_extension:
type: string
description: Extension to append to the rendered filename
maxLength: 15
as_attachment:
type: boolean
description: Download file as attachment
data_source:
oneOf:
- type: integer
- $ref: '#/components/schemas/BriefDataSourceRequest'
auto_sync_enabled:
type: boolean
description: Enable automatic synchronization of data when the data file is updated
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTagRequest'
NestedSiteGroup:
type: object
description: 'Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.'
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
_depth:
type: integer
readOnly: true
title: ' depth'
required:
- _depth
- display
- display_url
- id
- name
- slug
- url
PaginatedConfigContextProfileList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/ConfigContextProfile'
JournalEntry:
type: object
description: Adds support for custom fields and tags.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
assigned_object_type:
type: string
assigned_object_id:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
assigned_object:
readOnly: true
nullable: true
created:
type: string
format: date-time
readOnly: true
nullable: true
created_by:
type: integer
nullable: true
kind:
type: object
properties:
value:
enum:
- info
- success
- warning
- danger
type: string
description: '* `info` - Info
* `success` - Success
* `warning` - Warning
* `danger` - Danger'
x-spec-enum-id: 6f65abe0aab2c78c
label:
type: string
enum:
- Info
- Success
- Warning
- Danger
comments:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
custom_fields:
type: object
additionalProperties: {}
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
required:
- assigned_object
- assigned_object_id
- assigned_object_type
- comments
- created
- display
- display_url
- id
- last_updated
- url
DeviceType:
type: object
description: Base serializer class for models inheriting from PrimaryModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
manufacturer:
$ref: '#/components/schemas/BriefManufacturer'
default_platform:
allOf:
- $ref: '#/components/schemas/BriefPlatform'
nullable: true
model:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
part_number:
type: string
description: Discrete part number (optional)
maxLength: 50
u_height:
type: number
format: double
maximum: 1000
minimum: 0
exclusiveMaximum: true
default: 1.0
title: Position (U)
exclude_from_utilization:
type: boolean
description: Devices of this type are excluded when calculating rack utilization.
is_full_depth:
type: boolean
description: Device consumes both front and rear rack faces.
subdevice_role:
type: object
properties:
value:
enum:
- parent
- child
- ''
- null
type: string
description: '* `parent` - Parent
* `child` - Child'
x-spec-enum-id: 65a61d5e1deb4a24
label:
type: string
enum:
- Parent
- Child
nullable: true
airflow:
type: object
properties:
value:
enum:
- front-to-rear
- rear-to-front
- left-to-right
- right-to-left
- side-to-rear
- rear-to-side
- bottom-to-top
- top-to-bottom
- passive
- mixed
- ''
- null
type: string
description: '* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front
* `left-to-right` - Left to right
* `right-to-left` - Right to left
* `side-to-rear` - Side to rear
* `rear-to-side` - Rear to side
* `bottom-to-top` - Bottom to top
* `top-to-bottom` - Top to bottom
* `passive` - Passive
* `mixed` - Mixed'
x-spec-enum-id: 11cb3d363b41ba9e
label:
type: string
enum:
- Front to rear
- Rear to front
- Left to right
- Right to left
- Side to rear
- Rear to side
- Bottom to top
- Top to bottom
- Passive
- Mixed
nullable: true
weight:
type: number
format: double
maximum: 1000000
minimum: -1000000
exclusiveMaximum: true
exclusiveMinimum: true
nullable: true
weight_unit:
type: object
properties:
value:
enum:
- kg
- g
- lb
- oz
- ''
- null
type: string
description: '* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces'
x-spec-enum-id: 2235ce3f404afbc0
label:
type: string
enum:
- Kilograms
- Grams
- Pounds
- Ounces
nullable: true
front_image:
type: string
format: uri
nullable: true
rear_image:
type: string
format: uri
nullable: true
description:
type: string
maxLength: 200
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
comments:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
custom_fields:
type: object
additionalProperties: {}
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
device_count:
type: integer
readOnly: true
console_port_template_count:
type: integer
readOnly: true
console_server_port_template_count:
type: integer
readOnly: true
power_port_template_count:
type: integer
readOnly: true
power_outlet_template_count:
type: integer
readOnly: true
interface_template_count:
type: integer
readOnly: true
front_port_template_count:
type: integer
readOnly: true
rear_port_template_count:
type: integer
readOnly: true
device_bay_template_count:
type: integer
readOnly: true
module_bay_template_count:
type: integer
readOnly: true
inventory_item_template_count:
type: integer
readOnly: true
required:
- console_port_template_count
- console_server_port_template_count
- created
- device_bay_template_count
- device_count
- display
- display_url
- front_port_template_count
- id
- interface_template_count
- inventory_item_template_count
- last_updated
- manufacturer
- model
- module_bay_template_count
- power_outlet_template_count
- power_port_template_count
- rear_port_template_count
- slug
- url
PaginatedJournalEntryList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/JournalEntry'
PaginatedCustomFieldChoiceSetList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/CustomFieldChoiceSet'
DashboardRequest:
type: object
properties:
layout: {}
config: {}
BriefDataFile:
type: object
description: Adds support for custom fields and tags.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
path:
type: string
readOnly: true
description: File path relative to the data source's root
required:
- display
- id
- path
- url
PatchedConfigContextRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
name:
type: string
minLength: 1
maxLength: 100
weight:
type: integer
maximum: 32767
minimum: 0
profile:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefConfigContextProfileRequest'
nullable: true
nullable: true
description:
type: string
maxLength: 200
is_active:
type: boolean
regions:
type: array
items:
type: integer
site_groups:
type: array
items:
type: integer
sites:
type: array
items:
type: integer
locations:
type: array
items:
type: integer
device_types:
type: array
items:
type: integer
roles:
type: array
items:
type: integer
platforms:
type: array
items:
type: integer
cluster_types:
type: array
items:
type: integer
cluster_groups:
type: array
items:
type: integer
clusters:
type: array
items:
type: integer
tenant_groups:
type: array
items:
type: integer
tenants:
type: array
items:
type: integer
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
tags:
type: array
items:
type: string
minLength: 1
data_source:
oneOf:
- type: integer
- $ref: '#/components/schemas/BriefDataSourceRequest'
data: {}
BriefSiteGroup:
type: object
description: Base serializer class for models inheriting from NestedGroupModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
description:
type: string
maxLength: 200
site_count:
type: integer
readOnly: true
default: 0
_depth:
type: integer
readOnly: true
title: ' depth'
required:
- _depth
- display
- id
- name
- site_count
- slug
- url
Subscription:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
object_type:
type: string
object_id:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
object:
readOnly: true
nullable: true
user:
$ref: '#/components/schemas/BriefUser'
created:
type: string
format: date-time
readOnly: true
required:
- created
- display
- id
- object
- object_id
- object_type
- url
- user
PatchedSavedFilterRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
object_types:
type: array
items:
type: string
name:
type: string
minLength: 1
maxLength: 100
slug:
type: string
minLength: 1
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
description:
type: string
maxLength: 200
user:
type: integer
nullable: true
weight:
type: integer
maximum: 32767
minimum: 0
enabled:
type: boolean
shared:
type: boolean
parameters: {}
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
SubscriptionRequest:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
object_type:
type: string
object_id:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
user:
oneOf:
- type: integer
- $ref: '#/components/schemas/BriefUserRequest'
required:
- object_id
- object_type
- user
BriefRIR:
type: object
description: Base serializer class for models inheriting from OrganizationalModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
description:
type: string
maxLength: 200
aggregate_count:
type: integer
format: int64
readOnly: true
required:
- aggregate_count
- display
- id
- name
- slug
- url
PatchedScriptInputRequest:
type: object
properties:
data: {}
commit:
type: boolean
schedule_at:
type: string
format: date-time
nullable: true
interval:
type: integer
nullable: true
WritableCustomFieldRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
object_types:
type: array
items:
type: string
type:
enum:
- text
- longtext
- integer
- decimal
- boolean
- date
- datetime
- url
- json
- select
- multiselect
- object
- multiobject
type: string
x-spec-enum-id: 47c52a3d983e924c
description: 'The type of data this custom field holds
* `text` - Text
* `longtext` - Text (long)
* `integer` - Integer
* `decimal` - Decimal
* `boolean` - Boolean (true/false)
* `date` - Date
* `datetime` - Date & time
* `url` - URL
* `json` - JSON
* `select` - Selection
* `multiselect` - Multiple selection
* `object` - Object
* `multiobject` - Multiple objects'
related_object_type:
type: string
nullable: true
name:
type: string
minLength: 1
description: Internal field name
pattern: ^[a-z0-9_]+$
maxLength: 50
label:
type: string
description: Name of the field as displayed to users (if not provided, 'the field's name will be used)
maxLength: 50
group_name:
type: string
description: Custom fields within the same group will be displayed together
maxLength: 50
description:
type: string
maxLength: 200
required:
type: boolean
description: This field is required when creating new objects or editing an existing object.
unique:
type: boolean
title: Must be unique
description: The value of this field must be unique for the assigned object
search_weight:
type: integer
maximum: 32767
minimum: 0
description: Weighting for search. Lower values are considered more important. Fields with a search weight of zero will be ignored.
filter_logic:
enum:
- disabled
- loose
- exact
type: string
x-spec-enum-id: d168820c798ae45a
description: 'Loose matches any instance of a given string; exact matches the entire field.
* `disabled` - Disabled
* `loose` - Loose
* `exact` - Exact'
ui_visible:
enum:
- always
- if-set
- hidden
type: string
x-spec-enum-id: f32800c399b927b6
description: 'Specifies whether the custom field is displayed in the UI
* `always` - Always
* `if-set` - If set
* `hidden` - Hidden'
ui_editable:
enum:
- 'yes'
- 'no'
- hidden
type: string
x-spec-enum-id: 336f52760e62022f
description: 'Specifies whether the custom field value can be edited in the UI
* `yes` - Yes
* `no` - No
* `hidden` - Hidden'
is_cloneable:
type: boolean
description: Replicate this value when cloning objects
default:
nullable: true
description: Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. "Foo").
related_object_filter:
nullable: true
description: Filter the object selection choices using a query_params dict (must be a JSON value).Encapsulate strings with double quotes (e.g. "Foo").
weight:
type: integer
maximum: 32767
minimum: 0
title: Display weight
description: Fields with higher weights appear lower in a form.
validation_minimum:
type: number
format: double
maximum: 1000000000000
minimum: -1000000000000
exclusiveMaximum: true
exclusiveMinimum: true
nullable: true
title: Minimum value
description: Minimum allowed value (for numeric fields)
validation_maximum:
type: number
format: double
maximum: 1000000000000
minimum: -1000000000000
exclusiveMaximum: true
exclusiveMinimum: true
nullable: true
title: Maximum value
description: Maximum allowed value (for numeric fields)
validation_regex:
type: string
description: Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, ^[A-Z]{3}$ will limit values to exactly three uppercase letters.
maxLength: 500
choice_set:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefCustomFieldChoiceSetRequest'
nullable: true
nullable: true
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
comments:
type: string
required:
- name
- object_types
NestedUser:
type: object
description: 'Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.'
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
username:
type: string
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
pattern: ^[\w.@+-]+$
maxLength: 150
required:
- display
- display_url
- id
- url
- username
PatchedExportTemplateRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
object_types:
type: array
items:
type: string
name:
type: string
minLength: 1
maxLength: 100
description:
type: string
maxLength: 200
environment_params:
nullable: true
title: Environment parameters
description: Any additional parameters to pass when constructing the Jinja environment
template_code:
type: string
minLength: 1
description: Jinja template code.
mime_type:
type: string
description: Defaults to text/plain; charset=utf-8
maxLength: 50
file_name:
type: string
description: Filename to give to the rendered export file
maxLength: 200
file_extension:
type: string
description: Extension to append to the rendered filename
maxLength: 15
as_attachment:
type: boolean
description: Download file as attachment
data_source:
oneOf:
- type: integer
- $ref: '#/components/schemas/BriefDataSourceRequest'
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
PaginatedNotificationGroupList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/NotificationGroup'
PatchedSubscriptionRequest:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
object_type:
type: string
object_id:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
user:
oneOf:
- type: integer
- $ref: '#/components/schemas/BriefUserRequest'
BriefPlatform:
type: object
description: Base serializer class for models inheriting from NestedGroupModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
description:
type: string
maxLength: 200
device_count:
type: integer
readOnly: true
default: 0
virtualmachine_count:
type: integer
readOnly: true
default: 0
_depth:
type: integer
readOnly: true
title: ' depth'
required:
- _depth
- device_count
- display
- id
- name
- slug
- url
- virtualmachine_count
TableConfig:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
object_type:
type: string
table:
type: string
maxLength: 100
name:
type: string
maxLength: 100
description:
type: string
maxLength: 200
user:
type: integer
nullable: true
weight:
type: integer
maximum: 32767
minimum: 0
enabled:
type: boolean
shared:
type: boolean
columns:
type: array
items:
type: string
maxLength: 100
ordering:
type: array
items:
type: string
maxLength: 100
nullable: true
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
required:
- columns
- created
- display
- display_url
- id
- last_updated
- name
- object_type
- table
- url
ExportTemplateRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
object_types:
type: array
items:
type: string
name:
type: string
minLength: 1
maxLength: 100
description:
type: string
maxLength: 200
environment_params:
nullable: true
title: Environment parameters
description: Any additional parameters to pass when constructing the Jinja environment
template_code:
type: string
minLength: 1
description: Jinja template code.
mime_type:
type: string
description: Defaults to text/plain; charset=utf-8
maxLength: 50
file_name:
type: string
description: Filename to give to the rendered export file
maxLength: 200
file_extension:
type: string
description: Extension to append to the rendered filename
maxLength: 15
as_attachment:
type: boolean
description: Download file as attachment
data_source:
oneOf:
- type: integer
- $ref: '#/components/schemas/BriefDataSourceRequest'
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
required:
- name
- object_types
- template_code
ScriptInputRequest:
type: object
properties:
data: {}
commit:
type: boolean
schedule_at:
type: string
format: date-time
nullable: true
interval:
type: integer
nullable: true
required:
- commit
- data
ScriptModuleRequest:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
file:
type: string
format: binary
writeOnly: true
required:
- file
CustomLink:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
object_types:
type: array
items:
type: string
name:
type: string
maxLength: 100
enabled:
type: boolean
link_text:
type: string
description: Jinja2 template code for link text
link_url:
type: string
description: Jinja2 template code for link URL
weight:
type: integer
maximum: 32767
minimum: 0
group_name:
type: string
description: Links with the same group will appear as a dropdown menu
maxLength: 50
button_class:
enum:
- default
- blue
- indigo
- purple
- pink
- red
- orange
- yellow
- green
- teal
- cyan
- gray
- black
- white
- ghost-dark
type: string
x-spec-enum-id: 5e54b3bd086685ce
description: 'The class of the first link in a group will be used for the dropdown button
* `default` - Default
* `blue` - Blue
* `indigo` - Indigo
* `purple` - Purple
* `pink` - Pink
* `red` - Red
* `orange` - Orange
* `yellow` - Yellow
* `green` - Green
* `teal` - Teal
* `cyan` - Cyan
* `gray` - Gray
* `black` - Black
* `white` - White
* `ghost-dark` - Link'
new_window:
type: boolean
description: Force link to open in a new window
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
required:
- created
- display
- display_url
- id
- last_updated
- link_text
- link_url
- name
- object_types
- url
Site:
type: object
description: Base serializer class for models inheriting from PrimaryModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
description: Full name of the site
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
status:
type: object
properties:
value:
enum:
- planned
- staging
- active
- decommissioning
- retired
type: string
description: '* `planned` - Planned
* `staging` - Staging
* `active` - Active
* `decommissioning` - Decommissioning
* `retired` - Retired'
x-spec-enum-id: 1cf60831fbb35e7f
label:
type: string
enum:
- Planned
- Staging
- Active
- Decommissioning
- Retired
region:
allOf:
- $ref: '#/components/schemas/BriefRegion'
nullable: true
group:
allOf:
- $ref: '#/components/schemas/BriefSiteGroup'
nullable: true
tenant:
allOf:
- $ref: '#/components/schemas/BriefTenant'
nullable: true
facility:
type: string
description: Local facility ID or description
maxLength: 50
time_zone:
type: string
nullable: true
description:
type: string
maxLength: 200
physical_address:
type: string
description: Physical location of the building
maxLength: 200
shipping_address:
type: string
description: If different from the physical address
maxLength: 200
latitude:
type: number
format: double
maximum: 90.0
minimum: -90.0
nullable: true
description: GPS coordinate in decimal format (xx.yyyyyy)
longitude:
type: number
format: double
maximum: 180.0
minimum: -180.0
nullable: true
description: GPS coordinate in decimal format (xx.yyyyyy)
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
comments:
type: string
asns:
type: array
items:
$ref: '#/components/schemas/ASN'
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
custom_fields:
type: object
additionalProperties: {}
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
circuit_count:
type: integer
format: int64
readOnly: true
device_count:
type: integer
format: int64
readOnly: true
prefix_count:
type: integer
format: int64
readOnly: true
rack_count:
type: integer
format: int64
readOnly: true
virtualmachine_count:
type: integer
format: int64
readOnly: true
vlan_count:
type: integer
format: int64
readOnly: true
required:
- circuit_count
- created
- device_count
- display
- display_url
- id
- last_updated
- name
- prefix_count
- rack_count
- slug
- url
- virtualmachine_count
- vlan_count
PatchedConfigContextProfileRequest:
type: object
description: Base serializer class for models inheriting from PrimaryModel.
properties:
name:
type: string
minLength: 1
maxLength: 100
description:
type: string
maxLength: 200
schema:
nullable: true
description: A JSON schema specifying the structure of the context data for this profile
tags:
type: array
items:
$ref: '#/components/schemas/NestedTagRequest'
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
comments:
type: string
data_source:
oneOf:
- type: integer
- $ref: '#/components/schemas/BriefDataSourceRequest'
TenantGroup:
type: object
description: Base serializer class for models inheriting from NestedGroupModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
parent:
allOf:
- $ref: '#/components/schemas/NestedTenantGroup'
nullable: true
description:
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
custom_fields:
type: object
additionalProperties: {}
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
tenant_count:
type: integer
readOnly: true
default: 0
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
comments:
type: string
_depth:
type: integer
readOnly: true
title: ' depth'
required:
- _depth
- created
- display
- display_url
- id
- last_updated
- name
- slug
- tenant_count
- url
PaginatedSavedFilterList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/SavedFilter'
PaginatedCustomFieldList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/CustomField'
NestedRegion:
type: object
description: 'Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.'
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
_depth:
type: integer
readOnly: true
title: ' depth'
required:
- _depth
- display
- display_url
- id
- name
- slug
- url
TableConfigRequest:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
object_type:
type: string
table:
type: string
minLength: 1
maxLength: 100
name:
type: string
minLength: 1
maxLength: 100
description:
type: string
maxLength: 200
user:
type: integer
nullable: true
weight:
type: integer
maximum: 32767
minimum: 0
enabled:
type: boolean
shared:
type: boolean
columns:
type: array
items:
type: string
minLength: 1
maxLength: 100
ordering:
type: array
items:
type: string
minLength: 1
maxLength: 100
nullable: true
required:
- columns
- name
- object_type
- table
NestedDeviceRole:
type: object
description: 'Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.'
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
required:
- display
- display_url
- id
- name
- url
TagRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
name:
type: string
minLength: 1
maxLength: 100
slug:
type: string
minLength: 1
pattern: ^[-\w]+$
maxLength: 100
color:
type: string
minLength: 1
pattern: ^[0-9a-f]{6}$
maxLength: 6
description:
type: string
maxLength: 200
weight:
type: integer
maximum: 32767
minimum: 0
object_types:
type: array
items:
type: string
required:
- name
- slug
PaginatedEventRuleList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/EventRule'
ASNSite:
type: object
description: 'This serializer is meant for inclusion in ASNSerializer and is only used
to avoid a circular import of SiteSerializer.'
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
description: Full name of the site
maxLength: 100
description:
type: string
maxLength: 200
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
required:
- display
- id
- name
- slug
- url
Location:
type: object
description: Base serializer class for models inheriting from NestedGroupModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
site:
$ref: '#/components/schemas/BriefSite'
parent:
allOf:
- $ref: '#/components/schemas/NestedLocation'
nullable: true
status:
type: object
properties:
value:
enum:
- planned
- staging
- active
- decommissioning
- retired
type: string
description: '* `planned` - Planned
* `staging` - Staging
* `active` - Active
* `decommissioning` - Decommissioning
* `retired` - Retired'
x-spec-enum-id: 1cf60831fbb35e7f
label:
type: string
enum:
- Planned
- Staging
- Active
- Decommissioning
- Retired
tenant:
allOf:
- $ref: '#/components/schemas/BriefTenant'
nullable: true
facility:
type: string
description: Local facility ID or description
maxLength: 50
description:
type: string
maxLength: 200
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
custom_fields:
type: object
additionalProperties: {}
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
rack_count:
type: integer
readOnly: true
default: 0
device_count:
type: integer
readOnly: true
default: 0
prefix_count:
type: integer
format: int64
readOnly: true
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
comments:
type: string
_depth:
type: integer
readOnly: true
title: ' depth'
required:
- _depth
- created
- device_count
- display
- display_url
- id
- last_updated
- name
- prefix_count
- rack_count
- site
- slug
- url
WritableEventRuleRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
object_types:
type: array
items:
type: string
name:
type: string
minLength: 1
maxLength: 150
enabled:
type: boolean
event_types:
type: array
items:
enum:
- object_created
- object_updated
- object_deleted
- job_started
- job_completed
- job_failed
- job_errored
type: string
description: '* `object_created` - Object created
* `object_updated` - Object updated
* `object_deleted` - Object deleted
* `job_started` - Job started
* `job_completed` - Job completed
* `job_failed` - Job failed
* `job_errored` - Job errored'
x-spec-enum-id: 01e557313a5c7bd2
description: The types of event which will trigger this rule.
conditions:
nullable: true
description: A set of conditions which determine whether the event will be generated.
action_type:
enum:
- webhook
- script
- notification
type: string
description: '* `webhook` - Webhook
* `script` - Script
* `notification` - Notification'
x-spec-enum-id: 287901b937995956
action_object_type:
type: string
action_object_id:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
nullable: true
description:
type: string
maxLength: 200
custom_fields:
type: object
additionalProperties: {}
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTagRequest'
required:
- action_object_type
- event_types
- name
- object_types
NestedPlatform:
type: object
description: 'Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.'
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
required:
- display
- display_url
- id
- name
- url
EventRuleRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
object_types:
type: array
items:
type: string
name:
type: string
minLength: 1
maxLength: 150
enabled:
type: boolean
event_types:
type: array
items:
enum:
- object_created
- object_updated
- object_deleted
- job_started
- job_completed
- job_failed
- job_errored
type: string
description: '* `object_created` - Object created
* `object_updated` - Object updated
* `object_deleted` - Object deleted
* `job_started` - Job started
* `job_completed` - Job completed
* `job_failed` - Job failed
* `job_errored` - Job errored'
x-spec-enum-id: 01e557313a5c7bd2
description: The types of event which will trigger this rule.
conditions:
nullable: true
description: A set of conditions which determine whether the event will be generated.
action_type:
enum:
- webhook
- script
- notification
type: string
description: '* `webhook` - Webhook
* `script` - Script
* `notification` - Notification'
x-spec-enum-id: 287901b937995956
action_object_type:
type: string
action_object_id:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
nullable: true
description:
type: string
maxLength: 200
custom_fields:
type: object
additionalProperties: {}
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
tags:
type: array
items:
$ref: '#/components/schemas/NestedTagRequest'
required:
- action_object_type
- action_type
- event_types
- name
- object_types
BriefCustomFieldChoiceSetRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
name:
type: string
minLength: 1
maxLength: 100
description:
type: string
maxLength: 200
required:
- name
BriefUser:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
username:
type: string
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
pattern: ^[\w.@+-]+$
maxLength: 150
required:
- display
- id
- url
- username
BriefTenantGroup:
type: object
description: Base serializer class for models inheriting from NestedGroupModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
description:
type: string
maxLength: 200
tenant_count:
type: integer
readOnly: true
default: 0
_depth:
type: integer
readOnly: true
title: ' depth'
required:
- _depth
- display
- id
- name
- slug
- tenant_count
- url
PaginatedTableConfigList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/TableConfig'
NestedTag:
type: object
description: 'Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.'
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
pattern: ^[-\w]+$
maxLength: 100
color:
type: string
pattern: ^[0-9a-f]{6}$
maxLength: 6
required:
- display
- display_url
- id
- name
- slug
- url
BriefTenant:
type: object
description: Base serializer class for models inheriting from PrimaryModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
name:
type: string
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
description:
type: string
maxLength: 200
required:
- display
- id
- name
- slug
- url
NotificationRequest:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
object_type:
type: string
object_id:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
user:
oneOf:
- type: integer
- $ref: '#/components/schemas/BriefUserRequest'
read:
type: string
format: date-time
nullable: true
event_type:
enum:
- object_created
- object_updated
- object_deleted
- job_started
- job_completed
- job_failed
- job_errored
type: string
description: '* `object_created` - Object created
* `object_updated` - Object updated
* `object_deleted` - Object deleted
* `job_started` - Job started
* `job_completed` - Job completed
* `job_failed` - Job failed
* `job_errored` - Job errored'
x-spec-enum-id: 01e557313a5c7bd2
title: Event
required:
- event_type
- object_id
- object_type
- user
PatchedImageAttachmentRequest:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
object_type:
type: string
object_id:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
name:
type: string
maxLength: 50
image:
type: string
format: binary
description:
type: string
maxLength: 200
ASN:
type: object
description: Base serializer class for models inheriting from PrimaryModel.
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display_url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
asn:
type: integer
maximum: 4294967295
minimum: 1
format: int64
description: 16- or 32-bit autonomous system number
rir:
allOf:
- $ref: '#/components/schemas/BriefRIR'
nullable: true
tenant:
allOf:
- $ref: '#/components/schemas/BriefTenant'
nullable: true
description:
type: string
maxLength: 200
owner:
allOf:
- $ref: '#/components/schemas/BriefOwner'
nullable: true
comments:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/NestedTag'
custom_fields:
type: object
additionalProperties: {}
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
site_count:
type: integer
format: int64
readOnly: true
provider_count:
type: integer
format: int64
readOnly: true
sites:
type: array
items:
$ref: '#/components/schemas/ASNSite'
required:
- asn
- created
- display
- display_url
- id
- last_updated
- provider_count
- site_count
- url
ImageAttachment:
type: object
description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)'
properties:
id:
type: integer
readOnly: true
url:
type: string
format: uri
readOnly: true
display:
type: string
readOnly: true
object_type:
type: string
object_id:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
parent:
readOnly: true
nullable: true
name:
type: string
maxLength: 50
image:
type: string
format: uri
description:
type: string
maxLength: 200
image_height:
type: integer
readOnly: true
image_width:
type: integer
readOnly: true
created:
type: string
format: date-time
readOnly: true
nullable: true
last_updated:
type: string
format: date-time
readOnly: true
nullable: true
required:
- created
- display
- id
- image
- image_height
- image_width
- last_updated
- object_id
- object_type
- parent
- url
NestedTagRequest:
type: object
description: 'Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.'
properties:
name:
type: string
minLength: 1
maxLength: 100
slug:
type: string
minLength: 1
pattern: ^[-\w]+$
maxLength: 100
color:
type: string
minLength: 1
pattern: ^[0-9a-f]{6}$
maxLength: 6
required:
- name
- slug
SavedFilterRequest:
type: object
description: Adds an `owner` field for models which have a ForeignKey to users.Owner.
properties:
object_types:
type: array
items:
type: string
name:
type: string
minLength: 1
maxLength: 100
slug:
type: string
minLength: 1
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
description:
type: string
maxLength: 200
user:
type: integer
nullable: true
weight:
type: integer
maximum: 32767
minimum: 0
enabled:
type: boolean
shared:
type: boolean
parameters: {}
owner:
oneOf:
- type: integer
- allOf:
- $ref: '#/components/schemas/BriefOwnerRequest'
nullable: true
nullable: true
required:
- name
- object_types
- parameters
- slug
securitySchemes:
cookieAuth:
type: apiKey
in: cookie
name: sessionid
tokenAuth:
type: apiKey
in: header
name: Authorization
description: '`Token ` (v1) or `Bearer .` (v2)'