Open Inventory / Docs
EndpointsManufacturingResourcesIdOptions

Retrieve option groups and the current resource's selections

The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.

GET
/resources/{id}/options

The primary item represents the all-default combination. Generated combinations are ordinary first-class resource variants with independent operational data and sparse BOM overrides.

Authorization

bearerAuth
headerAuthorizationBearer <inv_ token>

Path Parameters

id*string
Formatuuid

Header Parameters

X-Organization-ID?string

Organization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.

Formatuuid

Response Body

Option matrix, BOM slots, and current selection

application/json
  1. response
role*string
Value in"primary""variant"
currentResourceId*string
Formatuuid
primary*
groups*array<>
configurations*array<>

Materialized configurations whose inventory items the caller may read.

currentSelection*array<>
bomSlots*array<>
combinationCount*integer
Range0 <= value <= 100
generatedVariantCount*integer
Range0 <= value
familyVariantCount*integer
Range0 <= value
definitionsLocked*boolean
Example Request
curl -X GET 'https://inventory.example.com/api/v1/resources/497f6eca-6276-4993-bfeb-53cbbbba6f08/options'
Example Response
{  "role": "primary",  "currentResourceId": "230f10e8-af7d-43d5-8837-788f4eb8cad2",  "primary": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "sku": "string"  },  "groups": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "key": "string",      "name": "string",      "bomSlotKey": "string",      "position": 0,      "values": [        {          "label": "string",          "code": "string",          "componentResourceId": "24634572-268e-41fb-a7f6-f1960b1ded93",          "isDefault": true,          "position": 0,          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "componentName": "string"        }      ]    }  ],  "configurations": [    {      "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",      "resourceName": "string",      "resourceSku": "string",      "isPrimary": true,      "signature": "string",      "selection": [        {          "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",          "groupName": "string",          "valueId": "b772d050-4ba4-443b-8ca7-cc1e42bdd731",          "valueLabel": "string"        }      ]    }  ],  "currentSelection": [    {      "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",      "groupName": "string",      "valueId": "b772d050-4ba4-443b-8ca7-cc1e42bdd731",      "valueLabel": "string"    }  ],  "bomSlots": [    {      "slotKey": "string",      "position": 0,      "componentResourceId": "24634572-268e-41fb-a7f6-f1960b1ded93",      "componentName": "string"    }  ],  "combinationCount": 0,  "generatedVariantCount": 0,  "familyVariantCount": 0,  "definitionsLocked": true}

List assemblies whose effective bill of materials uses this item GET

Includes direct primary-item BOM lines, inherited variant BOM lines, and sparse variant overrides. Parent assemblies that the caller cannot read are omitted.

Generate every non-default option combination POST

Atomically creates the Cartesian product as protected first-class variants, copies catalog and stock settings, stores selections, and writes only BOM differences. Maximum 100 total combinations.