> For the complete documentation index, see [llms.txt](https://docs.controlbee.nl/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.controlbee.nl/api/models.md).

# Models

## The ActionTracker object

```json
{"openapi":"3.1.0","info":{"title":"ControlBee API","version":"1.0.0"},"components":{"schemas":{"ActionTracker":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"workflow":{"type":"string","enum":["new","in.progress","for.review","ready","retired"]},"assessment":{"type":["string","null"],"description":"Assessment details for the action tracker in HTML."},"analysis":{"type":["string","null"],"description":"Analysis details for the action tracker in HTML."},"solution":{"type":["string","null"],"description":"Proposed solutions for the action tracker in HTML."},"target_date":{"type":["string","null"],"format":"date"},"created_at":{"type":"string","format":"date-time"},"reporter":{"oneOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}]},"assignee":{"oneOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}]},"action_tracker_type":{"type":["string","null"]},"followers":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"labels":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"color":{"type":"string"}}}},"comments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"action_tracker_id":{"type":"integer"},"comment":{"type":"string"},"is_subcomment":{"type":"boolean"},"parent_comment_id":{"type":["integer","null"],"description":"ID of the parent comment if this is a subcomment. NOTE: field will not be present if is_subcomment is false."},"updated_at":{"type":"string","format":"date-time"}}}}}},"User":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"}}}}}}
```

## The Context object

```json
{"openapi":"3.1.0","info":{"title":"ControlBee API","version":"1.0.0"},"components":{"schemas":{"Context":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"version":{"type":"string"}}}}}}
```

## The Evidence object

```json
{"openapi":"3.1.0","info":{"title":"ControlBee API","version":"1.0.0"},"components":{"schemas":{"Evidence":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":["string","null"]},"url":{"type":["string","null"]},"local_evidence_type":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"processes":{"type":"array","items":{"$ref":"#/components/schemas/Process"}},"measures":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}}}}}},"Process":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["draft","published"],"description":"Whether the returned description reflects a pending draft or the published version. An imported description lands in a draft, so the response reports 'draft' until the draft is published."},"description":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"version":{"type":"string"}}}}}}
```

## The ImageUpload object

```json
{"openapi":"3.1.0","info":{"title":"ControlBee API","version":"1.0.0"},"components":{"schemas":{"ImageUpload":{"type":"object","properties":{"url":{"type":"string","description":"The path the stored image is served from, relative to the tenant domain. Use this value as the 'src' of an image in content you send to ControlBee. The file name is generated on upload; the name of the uploaded file is not preserved."},"width":{"type":"integer","description":"The width of the stored image in pixels, after resizing."},"height":{"type":"integer","description":"The height of the stored image in pixels, after resizing."},"message":{"type":"string"}}}}}}
```

## The Policy object

```json
{"openapi":"3.1.0","info":{"title":"ControlBee API","version":"1.0.0"},"components":{"schemas":{"Policy":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"version":{"type":"string"}}}}}}
```

## The Process object

```json
{"openapi":"3.1.0","info":{"title":"ControlBee API","version":"1.0.0"},"components":{"schemas":{"Process":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["draft","published"],"description":"Whether the returned description reflects a pending draft or the published version. An imported description lands in a draft, so the response reports 'draft' until the draft is published."},"description":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"version":{"type":"string"}}}}}}
```

## The User object

```json
{"openapi":"3.1.0","info":{"title":"ControlBee API","version":"1.0.0"},"components":{"schemas":{"User":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"}}}}}}
```

## The Pagination object

```json
{"openapi":"3.1.0","info":{"title":"ControlBee API","version":"1.0.0"},"components":{"schemas":{"Pagination":{"type":"object","properties":{"current_page":{"type":"integer","description":"Current page number"},"last_page":{"type":"integer","description":"Last available page number"},"per_page":{"type":"integer","description":"Number of items per page"},"from":{"type":"integer","description":"Index of the first item in the current page"},"to":{"type":"integer","description":"Index of the last item in the current page"},"total":{"type":"integer","description":"Total number of items available"},"links":{"type":"array","description":"Pagination links","items":{"type":"object","properties":{"url":{"type":["string","null"],"description":"URL for the page link"},"label":{"type":"string","description":"Label for the page link"},"page":{"type":["integer","null"],"description":"Page number for the link"},"active":{"type":"boolean","description":"Indicates if this link is for the current page"}}}}}}}}}
```

## The UpdateActionTracker object

```json
{"openapi":"3.1.0","info":{"title":"ControlBee API","version":"1.0.0"},"components":{"schemas":{"UpdateActionTracker":{"type":"object","properties":{"name":{"type":"string","description":"The name of the action tracker."},"description":{"type":"string","description":"A detailed description of the action tracker."},"target_date":{"type":["string","null"],"format":"date","description":"The target date for the action tracker."},"workflow":{"type":["string","null"],"enum":["new","in.progress","for.review","ready","retired",null],"description":"Workflow status of the action tracker."},"analysis":{"type":["string","null"],"description":"Analysis related to the action tracker."},"solution":{"type":["string","null"],"description":"Proposed solution for the action tracker."},"assessment":{"type":["string","null"],"description":"Assessment details for the action tracker."},"reoccurring":{"type":["boolean","null"],"description":"Indicates if the action tracker is reoccurring."},"reoccurring_frequency":{"type":["string","null"],"enum":["monthly","quarterly","half-yearly","yearly","two-yearly",null],"description":"Frequency of reoccurrence for the action tracker."}}}}}}
```

## The ImageUploadRequest object

```json
{"openapi":"3.1.0","info":{"title":"ControlBee API","version":"1.0.0"},"components":{"schemas":{"ImageUploadRequest":{"type":"object","required":["upload"],"properties":{"upload":{"type":"string","format":"binary","description":"The image to upload, sent as multipart/form-data. Accepted formats are jpeg, png, gif, bmp and webp; SVG is not accepted. The file may not be larger than 4096 kilobytes. The image is stored at a maximum width of 2048 pixels and a thumbnail of 300 pixels wide is generated alongside it."}}}}}}
```

## The UpdateEvidence object

```json
{"openapi":"3.1.0","info":{"title":"ControlBee API","version":"1.0.0"},"components":{"schemas":{"UpdateEvidence":{"type":"object","properties":{"name":{"type":"string","description":"The name of the evidence."},"description":{"type":["string","null"],"description":"A detailed description of the evidence."},"url":{"type":["string","null"],"description":"A URL pointing to the evidence document."},"processes":{"type":"array","description":"UUIDs of processes to link to the evidence. Links are added; existing links are not removed.","items":{"type":"string"}},"measures":{"type":"array","description":"UUIDs of measures to link to the evidence. Links are added; existing links are not removed.","items":{"type":"string"}}}}}}}
```

## The UpdateDescription object

```json
{"openapi":"3.1.0","info":{"title":"ControlBee API","version":"1.0.0"},"components":{"schemas":{"UpdateDescription":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"The process description to import. You may supply either HTML or Markdown; use the X-Content-Format header to declare which (defaults to HTML). Markdown is converted to HTML on import. In both cases the result is sanitised before it is stored: only a safe subset of HTML is kept (headings, paragraphs, lists, tables, links, images, basic text formatting), scripts and event handlers are stripped, and inline base64 (data:) image sources are removed - so images must be referenced by a URL."}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.controlbee.nl/api/models.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.