Preference
Document resources/preference/overview
not found.
Attributes
Standard Representation
Included when the resource is the main response of a request, or is eager loaded.
Name | Type | Description |
---|---|---|
name | Unknown | The preference's name. |
value | Unknown | The preference's value. |
Minimal Representation
Included when the resource is returned as part of another resource.
Name | Type | Description |
---|---|---|
name | Unknown | The preference's name. |
value | Unknown | The preference's value. |
Actions
For Organization
Document resources/preference/actions/for_organization
not found.
GET
/org/{organization.id}/preference/{preference.name}
Template Variable | Type | Description |
---|---|---|
organization.id | Integer | Value uniquely identifying the organization. |
preference.name | Unknown | The preference's name. |
Query Parameter | Type | Description |
---|---|---|
include | [String] | List of attributes to eager load. |
Update
Document resources/preference/actions/update
not found.
PATCH
/org/{organization.id}/preference/{preference.name}
Template Variable | Type | Description |
---|---|---|
organization.id | Integer | Value uniquely identifying the organization. |
preference.name | Unknown | The preference's name. |
Accepted Parameter | Type | Description |
---|---|---|
preference.value | Unknown | The preference's value. |
PATCH
/preference/{preference.name}
Template Variable | Type | Description |
---|---|---|
preference.name | Unknown | The preference's name. |
Accepted Parameter | Type | Description |
---|---|---|
preference.value | Unknown | The preference's value. |
Find
Document resources/preference/actions/find
not found.
GET
/preference/{preference.name}
Template Variable | Type | Description |
---|---|---|
preference.name | Unknown | The preference's name. |
Query Parameter | Type | Description |
---|---|---|
include | [String] | List of attributes to eager load. |