policies_all_list

GET 
/policies/all/

Policy Viewset

Request

Query Parameters

bindings__isnull boolean
ordering string

Which field to use when ordering the results.

page integer

A page number within the paginated result set.

page_size integer

Number of results to return per page.

promptstage__isnull boolean
search string

A search term.

Responses

200

application/json

Schema

Schema

pagination

object

required

next numberrequired

previous numberrequired

count numberrequired

current numberrequired

total_pages numberrequired

start_index numberrequired

end_index numberrequired

results

object[]

required

Array [

pk uuidrequired

name stringrequired

execution_logging boolean

When this option is enabled, all executions of this policy will be logged. By default, only execution errors are logged.

component stringrequired

Get object component so that we know how to edit the object

verbose_name stringrequired

Return object's verbose_name

verbose_name_plural stringrequired

Return object's plural verbose_name

meta_model_name stringrequired

Return internal model name

bound_to integerrequired

Return objects policy is bound to

]

Example (from schema)

{
  "pagination": {
    "next": 0,
    "previous": 0,
    "count": 0,
    "current": 0,
    "total_pages": 0,
    "start_index": 0,
    "end_index": 0
  },
  "results": [
    {
      "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "execution_logging": true,
      "component": "string",
      "verbose_name": "string",
      "verbose_name_plural": "string",
      "meta_model_name": "string",
      "bound_to": 0
    }
  ]
}

400

application/json

Schema

Schema

non_field_errors string[]
code string
property name* any

Validation Error

Example (from schema)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detail stringrequired
code string

Example (from schema)

{
  "detail": "string",
  "code": "string"
}

Loading...