# Option Restrictions

####

## <mark style="color:green;">GET</mark> /configurator-option-restrictions

#### Simplio3D API: Configurator Option Restrictions (GET Endpoint)

The `configurator option restrictions` GET endpoint allows you to retrieve a list of options and their associated restrictions for product configurations.

**Endpoint**:\
`GET /open-api/v1/configurator-option-restrictions`

**Parameters**:

* `productId` (required): The ID of the product whose configuration options you want to retrieve.

**Response**:\
Returns a JSON object containing:

* `optionId`: The ID of the configuration option.
* `restrictedOptions`: A list of option IDs that are restricted when this option is chosen.

**Example Request**:

```http
GET /open-api/v1/configurator-option-restrictions?productId=12345
```

**Usage**:\
Use this endpoint to ensure that the user's selections adhere to the defined restrictions, providing a seamless and error-free configuration process.

**NOTE:** Ensure you have the necessary authorization credentials (e.g., Bearer Token) to access this endpoint which is taken from the 'Share' tab encryption token found at the bottom of the page.

## Retrieve a list of configurator option restrictions

> Get a list of configurator option restrictions.

```json
{"openapi":"3.0.0","info":{"title":"Simplio3D-Open REST API","version":"1.0.0"},"tags":[{"name":"Configurator Option Restrictions","description":"API Endpoints for managing configurator option restriction"}],"servers":[{"url":"https://app.simplio3d.com","description":"API Open Base URL"},{"url":""}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Enter token in format (Bearer <your_token>)"}},"schemas":{"ConfiguratorOptionRestrictionsResource":{"title":"Configurator Option Restrictions Resource","description":"Schema for configurator option restrictions","properties":{"id":{"type":"integer"},"configurator_id":{"type":"integer"},"configurator_option_id":{"type":"integer"},"configurator_option_value":{"type":"string"},"settings":{"type":"string"},"note":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"type":"object"}}},"paths":{"/api/open-api/v1/configurator-option-restrictions":{"get":{"tags":["Configurator Option Restrictions"],"summary":"Retrieve a list of configurator option restrictions","description":"Get a list of configurator option restrictions.","operationId":"16a2abcbb8c889a83c3c3c0297449814","parameters":[{"name":"configurator_option_id","in":"query","description":"The ID of the configurator option for which to retrieve restrictions.","required":false,"schema":{"type":"integer"}},{"name":"order_by","in":"query","description":"Column to order results by (e.g., 'created_at')","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Sorting order (asc or desc)","required":false,"schema":{"type":"string","enum":["asc","desc"]}},{"name":"per_page","in":"query","description":"Number of records per page (-1 for all records)","required":false,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"Number of page","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"List of configurator option restrictions","content":{"application/json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ConfiguratorOptionRestrictionsResource"}}},"type":"object"}}}},"400":{"description":"Invalid request parameters"},"401":{"description":"Unauthorized request"},"403":{"description":"Forbidden - user does not have permission"},"500":{"description":"Internal server error"}}}}}}
```

## The ConfiguratorOptionRestrictionsResource object

```json
{"openapi":"3.0.0","info":{"title":"Simplio3D-Open REST API","version":"1.0.0"},"components":{"schemas":{"ConfiguratorOptionRestrictionsResource":{"title":"Configurator Option Restrictions Resource","description":"Schema for configurator option restrictions","properties":{"id":{"type":"integer"},"configurator_id":{"type":"integer"},"configurator_option_id":{"type":"integer"},"configurator_option_value":{"type":"string"},"settings":{"type":"string"},"note":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"type":"object"}}}}
```


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.simplio3d.com/api-reference/open-api/options/option-restrictions.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.