POST/v2/adminconfig

Persönliche Administratorkonfiguration anlegen

Speichert data für die Kombination aus admin und config. Beide öffentlichen IDs und data sind erforderlich. Eine bereits vorhandene Kombination wird abgelehnt. data akzeptiert ein JSON-Objekt, eine Liste oder eine JSON-Zeichenfolge; der Server decodiert und speichert den Wert. Die Struktur ist konfigurationsabhängig. Ein Stapel von Datensätzen wird vom generischen Einfügepfad unterstützt.

Operation-ID post_v2_adminconfig

Vertrag & Verhalten

Dokumentationsstand: reviewed
Ändert Zustand: Ja
Als readOnly markiert: Nein
Für Automation markiert: Nein

Authentifizierung

Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).

Alternative 1

bearerAuthhttp · bearer

Existing edoobox v2 access token. Never substitute API key/secret headers.

Format: JWT

Security-Schema als JSON

{
  "type": "http",
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}

accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Alternative 2

sessionCookieapiKey

Existing browser login session, with the same permission checks as Bearer authentication.

cookie: _edlogin

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "cookie",
  "name": "_edlogin",
  "description": "Existing browser login session, with the same permission checks as Bearer authentication."
}

accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Berechtigungen

Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope.

Ressource: adminconfig · adcg
Levels: 2, 3, 4
Dispatcher-Prüfung: Ja

Parameter

Header

languageoptional

Account language code, where the resource supports setLanguage().

string

Schema-Beispiel

"de"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "de"
  ]
}

X-Edoobox-If-Revisionoptional

Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review.

string

pattern: "^[a-f0-9]{32}$"

Schema-Beispiel

"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$",
  "examples": [
    "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  ]
}

Request Body

erforderlich

`application/json`

object

data Typ nicht eingeschränkt erforderlich

anyOf · Mindestens eine Variante muss passen

Variante 1 object

Source-declared fields; action-specific and account validation still apply.

minProperties: 1

id kein Wert zulässig

config string erforderlich bei Anlage erforderlich beim Ändern nicht schreibbar

Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.

pattern: "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"config_012345abcdef_123456"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-writableOnUpdate": false,
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-schemaStatus": "source-inferred",
  "x-edoobox-sourceLine": 38
}

admin string erforderlich bei Anlage erforderlich beim Ändern nicht schreibbar

Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.

pattern: "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"admin_012345abcdef_123456"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-writableOnUpdate": false,
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-schemaStatus": "source-inferred",
  "x-edoobox-sourceLine": 52
}

data Typ nicht eingeschränkt erforderlich

Decoded object/array or a JSON-encoded string. The callback decodes string input before JSON/base64 storage; action-specific semantics remain dynamic.

anyOf · Mindestens eine Variante muss passen

Variante 1 object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Variante 2 array

Array-Elemente

Typ nicht eingeschränkt

Variante 3 string

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Adminconfigfunc.php",
      "line": 7,
      "reason": "PUT accepts decoded arrays or decodes JSON string input.",
      "sha256": "62186f93d05e34bcdfb65ca754cb101f75b25f7788c0cc647c6f27dfa0bad43b"
    },
    {
      "file": "application/models/v2/Adminconfigfunc.php",
      "line": 58,
      "reason": "POST before-insert transforms the same dynamic config payload.",
      "sha256": "62186f93d05e34bcdfb65ca754cb101f75b25f7788c0cc647c6f27dfa0bad43b"
    },
    {
      "file": "application/models/v2/Adminconfig.php",
      "line": 71,
      "reason": "Response json_decode can return dynamic JSON values.",
      "sha256": "7d2df83372bb7f880dad48503c6ab222b529c41cb136d3fbbb30979fe02c0deb"
    }
  ]
}

last_change Typ nicht eingeschränkt readOnly Eingabe wird ignoriert

Getter ignores input and returns time(). insert_default injects it on omission when present; omission otherwise does not call the getter.

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-schemaStatus": "source-reviewed-not-writable",
  "x-edoobox-clientRestriction": "Omit server-generated or unsupported input fields; runtime behavior is described separately.",
  "x-edoobox-ignoredInput": true,
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Adminconfig.php",
      "line": 80,
      "lineStart": 80,
      "lineEnd": 91,
      "sha256": "7d2df83372bb7f880dad48503c6ab222b529c41cb136d3fbbb30979fe02c0deb",
      "spanSha256": "96608b40202214fc8c808f25f65a2f7a426b711c2d0e9c79c7d8698ab9b9bb5d",
      "reason": "Structure getter, output setter and field flags."
    },
    {
      "file": "application/helpers/edooboxhelp_helper.php",
      "line": 11629,
      "lineStart": 11629,
      "lineEnd": 11639,
      "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e",
      "spanSha256": "a6fb9b218b0bdd5d6bc05d62034b2a1096d3279599319f181e03bc4a6fe7d83a",
      "reason": "dQ returns ISO date-time or false from stored time."
    },
    {
      "file": "application/models/v2/Adminconfig.php",
      "line": 104,
      "lineStart": 104,
      "lineEnd": 128,
      "sha256": "7d2df83372bb7f880dad48503c6ab222b529c41cb136d3fbbb30979fe02c0deb",
      "spanSha256": "dd5ca52305aef34e38c7a8e625b743be46f460fd72f1e6a5bcb136f948cd8628",
      "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
    },
    {
      "file": "docs/openapi/reviews/domain-fields.json",
      "line": 1,
      "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
      "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
    }
  ]
}

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Variante 2 array

minItems: 1
maxItems: 100

Array-Elemente

object

Source-declared fields; action-specific and account validation still apply.

id kein Wert zulässig

config string erforderlich bei Anlage erforderlich beim Ändern nicht schreibbar

Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.

pattern: "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"config_012345abcdef_123456"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-writableOnUpdate": false,
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-schemaStatus": "source-inferred",
  "x-edoobox-sourceLine": 38
}

admin string erforderlich bei Anlage erforderlich beim Ändern nicht schreibbar

Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.

pattern: "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"admin_012345abcdef_123456"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-writableOnUpdate": false,
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-schemaStatus": "source-inferred",
  "x-edoobox-sourceLine": 52
}

data Typ nicht eingeschränkt erforderlich

Decoded object/array or a JSON-encoded string. The callback decodes string input before JSON/base64 storage; action-specific semantics remain dynamic.

anyOf · Mindestens eine Variante muss passen

Variante 1 object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Variante 2 array

Array-Elemente

Typ nicht eingeschränkt

Variante 3 string

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Adminconfigfunc.php",
      "line": 7,
      "reason": "PUT accepts decoded arrays or decodes JSON string input.",
      "sha256": "62186f93d05e34bcdfb65ca754cb101f75b25f7788c0cc647c6f27dfa0bad43b"
    },
    {
      "file": "application/models/v2/Adminconfigfunc.php",
      "line": 58,
      "reason": "POST before-insert transforms the same dynamic config payload.",
      "sha256": "62186f93d05e34bcdfb65ca754cb101f75b25f7788c0cc647c6f27dfa0bad43b"
    },
    {
      "file": "application/models/v2/Adminconfig.php",
      "line": 71,
      "reason": "Response json_decode can return dynamic JSON values.",
      "sha256": "7d2df83372bb7f880dad48503c6ab222b529c41cb136d3fbbb30979fe02c0deb"
    }
  ]
}

last_change Typ nicht eingeschränkt readOnly Eingabe wird ignoriert

Getter ignores input and returns time(). insert_default injects it on omission when present; omission otherwise does not call the getter.

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-schemaStatus": "source-reviewed-not-writable",
  "x-edoobox-clientRestriction": "Omit server-generated or unsupported input fields; runtime behavior is described separately.",
  "x-edoobox-ignoredInput": true,
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Adminconfig.php",
      "line": 80,
      "lineStart": 80,
      "lineEnd": 91,
      "sha256": "7d2df83372bb7f880dad48503c6ab222b529c41cb136d3fbbb30979fe02c0deb",
      "spanSha256": "96608b40202214fc8c808f25f65a2f7a426b711c2d0e9c79c7d8698ab9b9bb5d",
      "reason": "Structure getter, output setter and field flags."
    },
    {
      "file": "application/helpers/edooboxhelp_helper.php",
      "line": 11629,
      "lineStart": 11629,
      "lineEnd": 11639,
      "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e",
      "spanSha256": "a6fb9b218b0bdd5d6bc05d62034b2a1096d3279599319f181e03bc4a6fe7d83a",
      "reason": "dQ returns ISO date-time or false from stored time."
    },
    {
      "file": "application/models/v2/Adminconfig.php",
      "line": 104,
      "lineStart": 104,
      "lineEnd": 128,
      "sha256": "7d2df83372bb7f880dad48503c6ab222b529c41cb136d3fbbb30979fe02c0deb",
      "spanSha256": "dd5ca52305aef34e38c7a8e625b743be46f460fd72f1e6a5bcb136f948cd8628",
      "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
    },
    {
      "file": "docs/openapi/reviews/domain-fields.json",
      "line": 1,
      "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
      "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
    }
  ]
}

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-readOnlyFields": [],
  "x-edoobox-clientRestriction": "The server-generated id is forbidden. insert:false fields are readOnly and tolerated for existing Vue payloads because the API skips them."
}

id string

Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.

pattern: "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"adminconfig_012345abcdef_123456"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "data": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": false,
            "config": {
              "type": "string",
              "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
              "examples": [
                "config_012345abcdef_123456"
              ],
              "x-edoobox-writableOnUpdate": false,
              "x-edoobox-requiredOnCreate": true,
              "x-edoobox-schemaStatus": "source-inferred",
              "x-edoobox-sourceLine": 38
            },
            "admin": {
              "type": "string",
              "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
              "examples": [
                "admin_012345abcdef_123456"
              ],
              "x-edoobox-writableOnUpdate": false,
              "x-edoobox-requiredOnCreate": true,
              "x-edoobox-schemaStatus": "source-inferred",
              "x-edoobox-sourceLine": 52
            },
            "data": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {},
                  "additionalProperties": true
                },
                {
                  "type": "array",
                  "items": {}
                },
                {
                  "type": "string"
                }
              ],
              "description": "Decoded object/array or a JSON-encoded string. The callback decodes string input before JSON/base64 storage; action-specific semantics remain dynamic.",
              "x-edoobox-contractSource": [
                {
                  "file": "application/models/v2/Adminconfigfunc.php",
                  "line": 7,
                  "reason": "PUT accepts decoded arrays or decodes JSON string input.",
                  "sha256": "62186f93d05e34bcdfb65ca754cb101f75b25f7788c0cc647c6f27dfa0bad43b"
                },
                {
                  "file": "application/models/v2/Adminconfigfunc.php",
                  "line": 58,
                  "reason": "POST before-insert transforms the same dynamic config payload.",
                  "sha256": "62186f93d05e34bcdfb65ca754cb101f75b25f7788c0cc647c6f27dfa0bad43b"
                },
                {
                  "file": "application/models/v2/Adminconfig.php",
                  "line": 71,
                  "reason": "Response json_decode can return dynamic JSON values.",
                  "sha256": "7d2df83372bb7f880dad48503c6ab222b529c41cb136d3fbbb30979fe02c0deb"
                }
              ]
            },
            "last_change": {
              "readOnly": true,
              "description": "Getter ignores input and returns time(). insert_default injects it on omission when present; omission otherwise does not call the getter. ",
              "x-edoobox-schemaStatus": "source-reviewed-not-writable",
              "x-edoobox-clientRestriction": "Omit server-generated or unsupported input fields; runtime behavior is described separately.",
              "x-edoobox-ignoredInput": true,
              "x-edoobox-contractSource": [
                {
                  "file": "application/models/v2/Adminconfig.php",
                  "line": 80,
                  "lineStart": 80,
                  "lineEnd": 91,
                  "sha256": "7d2df83372bb7f880dad48503c6ab222b529c41cb136d3fbbb30979fe02c0deb",
                  "spanSha256": "96608b40202214fc8c808f25f65a2f7a426b711c2d0e9c79c7d8698ab9b9bb5d",
                  "reason": "Structure getter, output setter and field flags."
                },
                {
                  "file": "application/helpers/edooboxhelp_helper.php",
                  "line": 11629,
                  "lineStart": 11629,
                  "lineEnd": 11639,
                  "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e",
                  "spanSha256": "a6fb9b218b0bdd5d6bc05d62034b2a1096d3279599319f181e03bc4a6fe7d83a",
                  "reason": "dQ returns ISO date-time or false from stored time."
                },
                {
                  "file": "application/models/v2/Adminconfig.php",
                  "line": 104,
                  "lineStart": 104,
                  "lineEnd": 128,
                  "sha256": "7d2df83372bb7f880dad48503c6ab222b529c41cb136d3fbbb30979fe02c0deb",
                  "spanSha256": "dd5ca52305aef34e38c7a8e625b743be46f460fd72f1e6a5bcb136f948cd8628",
                  "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
                },
                {
                  "file": "docs/openapi/reviews/domain-fields.json",
                  "line": 1,
                  "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                  "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
                }
              ]
            }
          },
          "additionalProperties": true,
          "description": "Source-declared fields; action-specific and account validation still apply.",
          "required": [
            "config",
            "admin",
            "data"
          ],
          "minProperties": 1
        },
        {
          "type": "array",
          "minItems": 1,
          "maxItems": 100,
          "items": {
            "type": "object",
            "properties": {
              "id": false,
              "config": {
                "type": "string",
                "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
                "examples": [
                  "config_012345abcdef_123456"
                ],
                "x-edoobox-writableOnUpdate": false,
                "x-edoobox-requiredOnCreate": true,
                "x-edoobox-schemaStatus": "source-inferred",
                "x-edoobox-sourceLine": 38
              },
              "admin": {
                "type": "string",
                "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
                "examples": [
                  "admin_012345abcdef_123456"
                ],
                "x-edoobox-writableOnUpdate": false,
                "x-edoobox-requiredOnCreate": true,
                "x-edoobox-schemaStatus": "source-inferred",
                "x-edoobox-sourceLine": 52
              },
              "data": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": true
                  },
                  {
                    "type": "array",
                    "items": {}
                  },
                  {
                    "type": "string"
                  }
                ],
                "description": "Decoded object/array or a JSON-encoded string. The callback decodes string input before JSON/base64 storage; action-specific semantics remain dynamic.",
                "x-edoobox-contractSource": [
                  {
                    "file": "application/models/v2/Adminconfigfunc.php",
                    "line": 7,
                    "reason": "PUT accepts decoded arrays or decodes JSON string input.",
                    "sha256": "62186f93d05e34bcdfb65ca754cb101f75b25f7788c0cc647c6f27dfa0bad43b"
                  },
                  {
                    "file": "application/models/v2/Adminconfigfunc.php",
                    "line": 58,
                    "reason": "POST before-insert transforms the same dynamic config payload.",
                    "sha256": "62186f93d05e34bcdfb65ca754cb101f75b25f7788c0cc647c6f27dfa0bad43b"
                  },
                  {
                    "file": "application/models/v2/Adminconfig.php",
                    "line": 71,
                    "reason": "Response json_decode can return dynamic JSON values.",
                    "sha256": "7d2df83372bb7f880dad48503c6ab222b529c41cb136d3fbbb30979fe02c0deb"
                  }
                ]
              },
              "last_change": {
                "readOnly": true,
                "description": "Getter ignores input and returns time(). insert_default injects it on omission when present; omission otherwise does not call the getter. ",
                "x-edoobox-schemaStatus": "source-reviewed-not-writable",
                "x-edoobox-clientRestriction": "Omit server-generated or unsupported input fields; runtime behavior is described separately.",
                "x-edoobox-ignoredInput": true,
                "x-edoobox-contractSource": [
                  {
                    "file": "application/models/v2/Adminconfig.php",
                    "line": 80,
                    "lineStart": 80,
                    "lineEnd": 91,
                    "sha256": "7d2df83372bb7f880dad48503c6ab222b529c41cb136d3fbbb30979fe02c0deb",
                    "spanSha256": "96608b40202214fc8c808f25f65a2f7a426b711c2d0e9c79c7d8698ab9b9bb5d",
                    "reason": "Structure getter, output setter and field flags."
                  },
                  {
                    "file": "application/helpers/edooboxhelp_helper.php",
                    "line": 11629,
                    "lineStart": 11629,
                    "lineEnd": 11639,
                    "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e",
                    "spanSha256": "a6fb9b218b0bdd5d6bc05d62034b2a1096d3279599319f181e03bc4a6fe7d83a",
                    "reason": "dQ returns ISO date-time or false from stored time."
                  },
                  {
                    "file": "application/models/v2/Adminconfig.php",
                    "line": 104,
                    "lineStart": 104,
                    "lineEnd": 128,
                    "sha256": "7d2df83372bb7f880dad48503c6ab222b529c41cb136d3fbbb30979fe02c0deb",
                    "spanSha256": "dd5ca52305aef34e38c7a8e625b743be46f460fd72f1e6a5bcb136f948cd8628",
                    "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
                  },
                  {
                    "file": "docs/openapi/reviews/domain-fields.json",
                    "line": 1,
                    "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                    "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
                  }
                ]
              }
            },
            "additionalProperties": true,
            "description": "Source-declared fields; action-specific and account validation still apply.",
            "required": [
              "config",
              "admin",
              "data"
            ]
          }
        }
      ],
      "x-edoobox-readOnlyFields": [],
      "x-edoobox-clientRestriction": "The server-generated id is forbidden. insert:false fields are readOnly and tolerated for existing Vue payloads because the API skips them."
    },
    "id": {
      "type": "string",
      "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
      "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
      "examples": [
        "adminconfig_012345abcdef_123456"
      ]
    }
  },
  "additionalProperties": true,
  "required": [
    "data"
  ]
}

Persönliche Administratorkonfiguration anlegen

{
  "data": {
    "config": "config_012345abcdef_123456",
    "admin": "admin_012345abcdef_123456",
    "data": {
      "columns": [
        "first_name",
        "last_name"
      ],
      "page_size": 25
    }
  }
}

Antworten

HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.

200application/json

Öffentliche adminconfig-ID beziehungsweise Liste von IDs und insert-Ergebnis.

Response Header

`X-Edoobox-Revision`

Rotated account revision supplied for the next action in one reviewed sequence.

string

pattern: "^[a-f0-9]{32}$"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$"
}

`application/json`

object

success boolean

error boolean | string

error_code string

data object

id Typ nicht eingeschränkt erforderlich

anyOf · Mindestens eine Variante muss passen

Variante 1 string

Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID.

pattern: "^adminconfig_[a-f0-9]{12}_-?[0-9]+$"

Variante 2 array

Array-Elemente

string

Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID.

pattern: "^adminconfig_[a-f0-9]{12}_-?[0-9]+$"

insert boolean erforderlich

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

type string

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "boolean",
        "string"
      ]
    },
    "error_code": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^adminconfig_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
            },
            {
              "type": "array",
              "items": {
                "type": "string",
                "pattern": "^adminconfig_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
              }
            }
          ]
        },
        "insert": {
          "type": "boolean"
        }
      },
      "additionalProperties": true,
      "required": [
        "id",
        "insert"
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "id": "adminconfig_012345abcdef_123456",
    "insert": true
  }
}

400application/json

Invalid request.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40006"
}

401application/json

Missing/expired token, missing account context, account paused or model-specific authorization failure.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40103"
}

402application/json

Missing/invalid action data or subscription/operation restriction.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80100"
}

403application/json

Permission denied. Browser CORS rejection may have an empty body.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40340"
}

404application/json

Unknown resource/action or unsupported method.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80019"
}

409application/json

The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.

`application/json`

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED40901",
  "error_code": "mutation_revision_conflict"
}

422application/json

Validation failed.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80020"
}

429application/json

Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.

Response Header

`Retry-After`

Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.

string

Schema-Beispiel

"30"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "30"
  ]
}

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED42902"
}

502application/json

Server-side operation failed.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED50201"
}

503application/json

The account mutation lock or revision store is unavailable. No unprotected fallback is executed.

Response Header

`application/json`

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED50301",
  "error_code": "mutation_revision_busy"
}

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Adminconfig.php:104postAdminconfig()

Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.

x-edoobox-mutates-state

true

x-edoobox-runtimeMutationGuard

true

x-edoobox-documentationReview

{
  "file": "docs/openapi/operation-contracts/06-admin-settings.json",
  "notes": []
}

x-edoobox-source

{
  "file": "application/models/v2/Adminconfig.php",
  "method": "postAdminconfig",
  "line": 104
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

false

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "resource": "adminconfig",
  "short": "adcg",
  "checkedByDispatcher": true,
  "levels": [
    2,
    3,
    4
  ],
  "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}

Vollständige Operation als JSON

{
  "operationId": "post_v2_adminconfig",
  "summary": "Persönliche Administratorkonfiguration anlegen",
  "description": "Speichert data für die Kombination aus admin und config. Beide öffentlichen IDs und data sind erforderlich. Eine bereits vorhandene Kombination wird abgelehnt. data akzeptiert ein JSON-Objekt, eine Liste oder eine JSON-Zeichenfolge; der Server decodiert und speichert den Wert. Die Struktur ist konfigurationsabhängig. Ein Stapel von Datensätzen wird vom generischen Einfügepfad unterstützt.",
  "tags": [
    "adminconfig"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    },
    {
      "name": "X-Edoobox-If-Revision",
      "in": "header",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-f0-9]{32}$",
        "examples": [
          "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        ]
      },
      "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review."
    }
  ],
  "responses": {
    "200": {
      "description": "Öffentliche adminconfig-ID beziehungsweise Liste von IDs und insert-Ergebnis.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "id": "adminconfig_012345abcdef_123456",
              "insert": true
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "id": {
                    "anyOf": [
                      {
                        "type": "string",
                        "pattern": "^adminconfig_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                      },
                      {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "pattern": "^adminconfig_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                        }
                      }
                    ]
                  },
                  "insert": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "id",
                  "insert"
                ]
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "headers": {
        "X-Edoobox-Revision": {
          "schema": {
            "type": "string",
            "pattern": "^[a-f0-9]{32}$"
          },
          "description": "Rotated account revision supplied for the next action in one reviewed sequence."
        }
      }
    },
    "400": {
      "description": "Invalid request.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40006"
          }
        }
      }
    },
    "401": {
      "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40103"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid action data or subscription/operation restriction.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100"
          }
        }
      }
    },
    "403": {
      "description": "Permission denied. Browser CORS rejection may have an empty body.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40340"
          }
        }
      }
    },
    "404": {
      "description": "Unknown resource/action or unsupported method.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80019"
          }
        }
      }
    },
    "409": {
      "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED40901",
            "error_code": "mutation_revision_conflict"
          }
        }
      }
    },
    "422": {
      "description": "Validation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80020"
          }
        }
      }
    },
    "429": {
      "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED42902"
          }
        }
      },
      "headers": {
        "Retry-After": {
          "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
          "schema": {
            "type": "string",
            "examples": [
              "30"
            ]
          }
        }
      }
    },
    "502": {
      "description": "Server-side operation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED50201"
          }
        }
      }
    },
    "503": {
      "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "const": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED50301",
            "error_code": "mutation_revision_busy"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": true,
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "id": false,
                    "config": {
                      "type": "string",
                      "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
                      "examples": [
                        "config_012345abcdef_123456"
                      ],
                      "x-edoobox-writableOnUpdate": false,
                      "x-edoobox-requiredOnCreate": true,
                      "x-edoobox-schemaStatus": "source-inferred",
                      "x-edoobox-sourceLine": 38
                    },
                    "admin": {
                      "type": "string",
                      "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
                      "examples": [
                        "admin_012345abcdef_123456"
                      ],
                      "x-edoobox-writableOnUpdate": false,
                      "x-edoobox-requiredOnCreate": true,
                      "x-edoobox-schemaStatus": "source-inferred",
                      "x-edoobox-sourceLine": 52
                    },
                    "data": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {},
                          "additionalProperties": true
                        },
                        {
                          "type": "array",
                          "items": {}
                        },
                        {
                          "type": "string"
                        }
                      ],
                      "description": "Decoded object/array or a JSON-encoded string. The callback decodes string input before JSON/base64 storage; action-specific semantics remain dynamic.",
                      "x-edoobox-contractSource": [
                        {
                          "file": "application/models/v2/Adminconfigfunc.php",
                          "line": 7,
                          "reason": "PUT accepts decoded arrays or decodes JSON string input.",
                          "sha256": "62186f93d05e34bcdfb65ca754cb101f75b25f7788c0cc647c6f27dfa0bad43b"
                        },
                        {
                          "file": "application/models/v2/Adminconfigfunc.php",
                          "line": 58,
                          "reason": "POST before-insert transforms the same dynamic config payload.",
                          "sha256": "62186f93d05e34bcdfb65ca754cb101f75b25f7788c0cc647c6f27dfa0bad43b"
                        },
                        {
                          "file": "application/models/v2/Adminconfig.php",
                          "line": 71,
                          "reason": "Response json_decode can return dynamic JSON values.",
                          "sha256": "7d2df83372bb7f880dad48503c6ab222b529c41cb136d3fbbb30979fe02c0deb"
                        }
                      ]
                    },
                    "last_change": {
                      "readOnly": true,
                      "description": "Getter ignores input and returns time(). insert_default injects it on omission when present; omission otherwise does not call the getter. ",
                      "x-edoobox-schemaStatus": "source-reviewed-not-writable",
                      "x-edoobox-clientRestriction": "Omit server-generated or unsupported input fields; runtime behavior is described separately.",
                      "x-edoobox-ignoredInput": true,
                      "x-edoobox-contractSource": [
                        {
                          "file": "application/models/v2/Adminconfig.php",
                          "line": 80,
                          "lineStart": 80,
                          "lineEnd": 91,
                          "sha256": "7d2df83372bb7f880dad48503c6ab222b529c41cb136d3fbbb30979fe02c0deb",
                          "spanSha256": "96608b40202214fc8c808f25f65a2f7a426b711c2d0e9c79c7d8698ab9b9bb5d",
                          "reason": "Structure getter, output setter and field flags."
                        },
                        {
                          "file": "application/helpers/edooboxhelp_helper.php",
                          "line": 11629,
                          "lineStart": 11629,
                          "lineEnd": 11639,
                          "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e",
                          "spanSha256": "a6fb9b218b0bdd5d6bc05d62034b2a1096d3279599319f181e03bc4a6fe7d83a",
                          "reason": "dQ returns ISO date-time or false from stored time."
                        },
                        {
                          "file": "application/models/v2/Adminconfig.php",
                          "line": 104,
                          "lineStart": 104,
                          "lineEnd": 128,
                          "sha256": "7d2df83372bb7f880dad48503c6ab222b529c41cb136d3fbbb30979fe02c0deb",
                          "spanSha256": "dd5ca52305aef34e38c7a8e625b743be46f460fd72f1e6a5bcb136f948cd8628",
                          "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
                        },
                        {
                          "file": "docs/openapi/reviews/domain-fields.json",
                          "line": 1,
                          "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                          "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
                        }
                      ]
                    }
                  },
                  "additionalProperties": true,
                  "description": "Source-declared fields; action-specific and account validation still apply.",
                  "required": [
                    "config",
                    "admin",
                    "data"
                  ],
                  "minProperties": 1
                },
                {
                  "type": "array",
                  "minItems": 1,
                  "maxItems": 100,
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": false,
                      "config": {
                        "type": "string",
                        "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
                        "examples": [
                          "config_012345abcdef_123456"
                        ],
                        "x-edoobox-writableOnUpdate": false,
                        "x-edoobox-requiredOnCreate": true,
                        "x-edoobox-schemaStatus": "source-inferred",
                        "x-edoobox-sourceLine": 38
                      },
                      "admin": {
                        "type": "string",
                        "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
                        "examples": [
                          "admin_012345abcdef_123456"
                        ],
                        "x-edoobox-writableOnUpdate": false,
                        "x-edoobox-requiredOnCreate": true,
                        "x-edoobox-schemaStatus": "source-inferred",
                        "x-edoobox-sourceLine": 52
                      },
                      "data": {
                        "anyOf": [
                          {
                            "type": "object",
                            "properties": {},
                            "additionalProperties": true
                          },
                          {
                            "type": "array",
                            "items": {}
                          },
                          {
                            "type": "string"
                          }
                        ],
                        "description": "Decoded object/array or a JSON-encoded string. The callback decodes string input before JSON/base64 storage; action-specific semantics remain dynamic.",
                        "x-edoobox-contractSource": [
                          {
                            "file": "application/models/v2/Adminconfigfunc.php",
                            "line": 7,
                            "reason": "PUT accepts decoded arrays or decodes JSON string input.",
                            "sha256": "62186f93d05e34bcdfb65ca754cb101f75b25f7788c0cc647c6f27dfa0bad43b"
                          },
                          {
                            "file": "application/models/v2/Adminconfigfunc.php",
                            "line": 58,
                            "reason": "POST before-insert transforms the same dynamic config payload.",
                            "sha256": "62186f93d05e34bcdfb65ca754cb101f75b25f7788c0cc647c6f27dfa0bad43b"
                          },
                          {
                            "file": "application/models/v2/Adminconfig.php",
                            "line": 71,
                            "reason": "Response json_decode can return dynamic JSON values.",
                            "sha256": "7d2df83372bb7f880dad48503c6ab222b529c41cb136d3fbbb30979fe02c0deb"
                          }
                        ]
                      },
                      "last_change": {
                        "readOnly": true,
                        "description": "Getter ignores input and returns time(). insert_default injects it on omission when present; omission otherwise does not call the getter. ",
                        "x-edoobox-schemaStatus": "source-reviewed-not-writable",
                        "x-edoobox-clientRestriction": "Omit server-generated or unsupported input fields; runtime behavior is described separately.",
                        "x-edoobox-ignoredInput": true,
                        "x-edoobox-contractSource": [
                          {
                            "file": "application/models/v2/Adminconfig.php",
                            "line": 80,
                            "lineStart": 80,
                            "lineEnd": 91,
                            "sha256": "7d2df83372bb7f880dad48503c6ab222b529c41cb136d3fbbb30979fe02c0deb",
                            "spanSha256": "96608b40202214fc8c808f25f65a2f7a426b711c2d0e9c79c7d8698ab9b9bb5d",
                            "reason": "Structure getter, output setter and field flags."
                          },
                          {
                            "file": "application/helpers/edooboxhelp_helper.php",
                            "line": 11629,
                            "lineStart": 11629,
                            "lineEnd": 11639,
                            "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e",
                            "spanSha256": "a6fb9b218b0bdd5d6bc05d62034b2a1096d3279599319f181e03bc4a6fe7d83a",
                            "reason": "dQ returns ISO date-time or false from stored time."
                          },
                          {
                            "file": "application/models/v2/Adminconfig.php",
                            "line": 104,
                            "lineStart": 104,
                            "lineEnd": 128,
                            "sha256": "7d2df83372bb7f880dad48503c6ab222b529c41cb136d3fbbb30979fe02c0deb",
                            "spanSha256": "dd5ca52305aef34e38c7a8e625b743be46f460fd72f1e6a5bcb136f948cd8628",
                            "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
                          },
                          {
                            "file": "docs/openapi/reviews/domain-fields.json",
                            "line": 1,
                            "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                            "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
                          }
                        ]
                      }
                    },
                    "additionalProperties": true,
                    "description": "Source-declared fields; action-specific and account validation still apply.",
                    "required": [
                      "config",
                      "admin",
                      "data"
                    ]
                  }
                }
              ],
              "x-edoobox-readOnlyFields": [],
              "x-edoobox-clientRestriction": "The server-generated id is forbidden. insert:false fields are readOnly and tolerated for existing Vue payloads because the API skips them."
            },
            "id": {
              "type": "string",
              "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
              "examples": [
                "adminconfig_012345abcdef_123456"
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data"
          ]
        },
        "examples": {
          "request": {
            "summary": "Persönliche Administratorkonfiguration anlegen",
            "value": {
              "data": {
                "config": "config_012345abcdef_123456",
                "admin": "admin_012345abcdef_123456",
                "data": {
                  "columns": [
                    "first_name",
                    "last_name"
                  ],
                  "page_size": 25
                }
              }
            }
          }
        }
      }
    }
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/06-admin-settings.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Adminconfig.php",
    "method": "postAdminconfig",
    "line": 104
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "adminconfig",
    "short": "adcg",
    "checkedByDispatcher": true,
    "levels": [
      2,
      3,
      4
    ],
    "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
  }
}

Aufruf vorbereiten

Beispiel

Platzhalter ersetzen und Vertragsangaben prüfen. Die Beispiele werden hier nicht ausgeführt.

cURL

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
cat > payload.json <<'EDOOBOX_JSON_EXAMPLE'
{
  "data": {
    "config": "config_012345abcdef_123456",
    "admin": "admin_012345abcdef_123456",
    "data": {
      "columns": [
        "first_name",
        "last_name"
      ],
      "page_size": 25
    }
  }
}
EDOOBOX_JSON_EXAMPLE
curl --request 'POST' \
  --url "${API_ORIGIN%/}"'/v2/adminconfig' \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" \
  --header 'Content-Type: application/json' \
  --data-binary '@payload.json'

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/adminconfig";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "config": "config_012345abcdef_123456",
    "admin": "admin_012345abcdef_123456",
    "data": {
      "columns": [
        "first_name",
        "last_name"
      ],
      "page_size": 25
    }
  }
});
const response = await fetch(url, { method: "POST", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/adminconfig"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"config\":\"config_012345abcdef_123456\",\"admin\":\"admin_012345abcdef_123456\",\"data\":{\"columns\":[\"first_name\",\"last_name\"],\"page_size\":25}}}".encode("utf-8")

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="POST", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Ohne JavaScript können Sie die weiteren Aufrufbeispiele hier aufklappen und den Code manuell kopieren.

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/adminconfig";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "config": "config_012345abcdef_123456",
    "admin": "admin_012345abcdef_123456",
    "data": {
      "columns": [
        "first_name",
        "last_name"
      ],
      "page_size": 25
    }
  }
});
const response = await fetch(url, { method: "POST", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/adminconfig"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"config\":\"config_012345abcdef_123456\",\"admin\":\"admin_012345abcdef_123456\",\"data\":{\"columns\":[\"first_name\",\"last_name\"],\"page_size\":25}}}".encode("utf-8")

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="POST", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Server aus der Spezifikation

https://app2.edoobox.com

edoobox API

Verwenden Sie die für Ihre Integration bestätigte API-Basis-URL. Ein lokaler Entwicklungsserver ist keine Produktionsadresse.

Als Markdown lesenEin Endpunkt. Vollständig. Für Menschen und LLM.