> For the complete documentation index, see [llms.txt](https://docs.b2ihealthcare.com/snow-owl/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.b2ihealthcare.com/snow-owl/8.x/index-3/index-1/refsets.md).

# Reference Sets

Two categories make up Snow Owl's Reference Set API:

1. **Reference Sets** category to get, search, create and modify reference sets
2. **Reference Set Members** category to get, search, create and modify reference set members

Basic operations like create, update, delete are supported for both category.

## Actions API

On top of the basic operations, reference sets and members support actions. Actions have an *action* property to specify which action to execute, the rest of the JSON properties will be used as body for the Action.

Supported reference set actions are:

1. **sync** - synchronize all members of a query type reference set by executing their query and comparing the results with the current members of their referenced target reference set

Supported reference set member actions are:

1. **create** - create a reference set member (uses the same body as POST /members)
2. **update** - update a reference set member (uses the same body as PUT /members)
3. **delete** - delete a reference set member
4. **sync** - synchronize a single member by executing the query and comparing the results with the current members of the referenced target reference set

For example the following will sync a query type reference set member's referenced component with the result of the reevaluated member's ESCG query

```
POST /members/:id/actions
{
  "commitComment": "Sync member's target reference set",
  "action": "sync"
}
```

## Bulk API

Members list of a single reference set can be modified by using the following bulk-like update endpoint:

```
PUT /:path/refsets/:id/members
```

Input

```
{
  "commitComment": "Updating members of my simple type reference set",
  "requests": [
  	{
  	  "action": "create|update|delete|sync",
  	  "action-specific-props": ...
  	}
  ]
}
```

The request body should contain the commitComment property and a request array. The request array must contain actions (see Actions API) that are enabled for the given set of reference set members. Member create actions can omit the *referenceSetId* parameter, those will use the one defined as path parameter in the URL. For example by using this endpoint you can create, update and delete members of a reference set at once in one single commit.


---

# 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 dynamically by asking a question.

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

```
GET https://docs.b2ihealthcare.com/snow-owl/8.x/index-3/index-1/refsets.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.