Preferences

Generated preferences operations.

GET/v1/preferencesRead preferencesread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_preferences

Parameters

Name	In	Type	Description
`deviceClass`	query	`string`

Responses

200Successapplication/json

Example

{
  "data": {
    "audioEffects": {
      "crossfadeMs": 1800000,
      "dsdGainDb": 0,
      "gapless": true,
      "neverBoost": true,
      "normalization": "string",
      "smoothTransitions": true
    },
    "clampedFields": [
      "string"
    ],
    "deviceBound": true,
    "deviceClass": "string",
    "documents": [
      {
        "activeRevision": 0,
        "digest": "string",
        "revision": 0,
        "scope": "string",
        "values": {
          "key": null
        }
      }
    ],
    "effective": {
      "key": null
    },
    "effectiveSource": {
      "key": "string"
    },
    "registry": {
      "fields": [
        {
          "allowedValues": [],
          "consumer": "string",
          "default": null,
          "group": "string",
          "key": "string",
          "labelKey": "string",
          "max": 0,
          "min": 0,
          "scopes": [],
          "step": 0,
          "type": "string"
        }
      ],
      "revision": "r12"
    },
    "registryRevision": "r12"
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

Schema

dataobjectrequired
- audioEffectsobjectrequired
  - crossfadeMsintegerrequired
  - dsdGainDbintegerrequired
  - gaplessbooleanrequired
  - neverBoostbooleanrequired
  - normalizationstringrequired
  - smoothTransitionsbooleanrequired
- clampedFieldsarray of stringrequired
- deviceBoundbooleanrequired
- deviceClassstringrequired
- documentsarray of objectrequired
  - activeRevisionintegerrequired
  - digeststringrequired
  - revisionintegerrequired
  - scopestringrequired
  - valuesobjectrequired
- effectiveobjectrequired
- effectiveSourceobjectrequired
- registryobjectrequired
  - fieldsarray of objectrequired
    allowedValuesarray of any
    consumerstringrequired
    defaultanyrequired
    groupstringrequired
    keystringrequired
    labelKeystringrequired
    maxnumber
    minnumber
    scopesarray of stringrequired
    stepnumber
    typestringrequired
  - revisionstringrequired
- registryRevisionstringrequired
scopeobjectrequired
- serverIdstringrequired
- viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/preferences" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

PATCH/v1/preferencesChange preferencesplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: patch_preferences
Max body: 64 KiB

Parameters

Name	In	Type	Description
`Idempotency-Key`	header	`string`
`Portico-Mutation-Root`	header	`string`

Request body application/json · required

Example

{
  "deviceClass": "string",
  "expectedRevision": 0,
  "idempotencyKey": "string",
  "scope": "string",
  "values": {
    "key": null
  }
}

Schema

deviceClassstringrequired
expectedRevisionintegerrequired
idempotencyKeystringrequired
scopestringrequired
valuesobjectrequired

Responses

200Successapplication/json

Example

{
  "data": {
    "audioEffects": {
      "crossfadeMs": 1800000,
      "dsdGainDb": 0,
      "gapless": true,
      "neverBoost": true,
      "normalization": "string",
      "smoothTransitions": true
    },
    "clampedFields": [
      "string"
    ],
    "deviceBound": true,
    "deviceClass": "string",
    "documents": [
      {
        "activeRevision": 0,
        "digest": "string",
        "revision": 0,
        "scope": "string",
        "values": {
          "key": null
        }
      }
    ],
    "effective": {
      "key": null
    },
    "effectiveSource": {
      "key": "string"
    },
    "registry": {
      "fields": [
        {
          "allowedValues": [],
          "consumer": "string",
          "default": null,
          "group": "string",
          "key": "string",
          "labelKey": "string",
          "max": 0,
          "min": 0,
          "scopes": [],
          "step": 0,
          "type": "string"
        }
      ],
      "revision": "r12"
    },
    "registryRevision": "r12"
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

Schema

dataobjectrequired
- audioEffectsobjectrequired
  - crossfadeMsintegerrequired
  - dsdGainDbintegerrequired
  - gaplessbooleanrequired
  - neverBoostbooleanrequired
  - normalizationstringrequired
  - smoothTransitionsbooleanrequired
- clampedFieldsarray of stringrequired
- deviceBoundbooleanrequired
- deviceClassstringrequired
- documentsarray of objectrequired
  - activeRevisionintegerrequired
  - digeststringrequired
  - revisionintegerrequired
  - scopestringrequired
  - valuesobjectrequired
- effectiveobjectrequired
- effectiveSourceobjectrequired
- registryobjectrequired
  - fieldsarray of objectrequired
    allowedValuesarray of any
    consumerstringrequired
    defaultanyrequired
    groupstringrequired
    keystringrequired
    labelKeystringrequired
    maxnumber
    minnumber
    scopesarray of stringrequired
    stepnumber
    typestringrequired
  - revisionstringrequired
- registryRevisionstringrequired
scopeobjectrequired
- serverIdstringrequired
- viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternalidempotency_conflictreceipt_expiredinvalid_mutation_keydatabase_busywriter_capacity

Example request

curl -X PATCH "http://127.0.0.1:32500/v1/preferences" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"deviceClass":"string","expectedRevision":0,"idempotencyKey":"string","scope":"string","values":{"key":null}}'