> For the complete documentation index, see [llms.txt](https://docs.platform.softwareone.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.platform.softwareone.com/developer-resources/rest-api/catalog-api/documentation/documentation-states.md).

# State diagram

The following diagram shows the possible states for the documentation object in the Marketplace Platform and the transition between these states:

<figure><img src="https://content.gitbook.com/content/Z5DNbniz33mXCZoO62Rm/blobs/Q08pw0ZprKx8IhW1DPIr/Documentation.png" alt=""><figcaption><p>The state transition diagram of the documentation object.</p></figcaption></figure>

<table><thead><tr><th width="146">State</th><th>Definition</th></tr></thead><tbody><tr><td><strong>Draft</strong></td><td>The documentation object is being created by the vendor. The object is not visible to the clients yet in the marketplace.</td></tr><tr><td><strong>Pending</strong></td><td>The vendor has submitted the documentation object to SoftwareOne Operations for review and publishing.</td></tr><tr><td><strong>Published</strong></td><td>The documentation object is visible in the marketplace.</td></tr><tr><td><strong>Unpublished</strong></td><td>The documentation object is not visible in the marketplace.</td></tr><tr><td><strong>Deleted</strong></td><td>The document object no longer exists. It's no longer part of the product definition and can't be used.</td></tr></tbody></table>


---

# 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.platform.softwareone.com/developer-resources/rest-api/catalog-api/documentation/documentation-states.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.
