Zum Inhalt
edoobox Docs

Suchen Sie nach einer Aufgabe oder einem Thema, z. B. Rechnung oder Warteliste.
Kostenlos testen 7 Tage unverbindlich testen
Menü
Kostenlos testen 7 Tage unverbindlich testen
OpenAPI herunterladen
permissionAPI-Referenz
GET/v2/permission/{id}

Berechtigungsprofil lesen

Liest das durch die öffentliche Pfad-ID gewählte Berechtigungsprofil. Auch ein Einzelabruf liefert die normale GET-Datenstruktur; Feldauswahl, Filter und Konto-Berechtigungen bleiben wirksam.

Operation-ID get_v2_permission_id

01

Vertrag & Verhalten

Dokumentationsstand
reviewed
Ändert Zustand
Nein
Als readOnly markiert
Ja
Für Automation markiert
Ja
GET-Verhalten laut Spezifikation

read

02

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
permission · perm
Levels
1, 3, 4
Dispatcher-Prüfung
Ja
03

Parameter

Pfadparameter

iderforderlich

v2 object identifier in the selected account.

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
"permission_012345abcdef_123456"
Vollständiges Schema als JSON
{
  "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": [
    "permission_012345abcdef_123456"
  ]
}

Query-Parameter

fieldsoptional

JSON-encoded fields value consumed by RequestAPIData / API_DATA; specific actions may ignore it.

application/json

array
Schema-Beispiel
[
  "id"
]
Array-Elemente
string
Vollständiges Schema als JSON
{
  "type": "array",
  "items": {
    "type": "string"
  },
  "examples": [
    [
      "id"
    ]
  ]
}
Beispiel
[
  "id"
]
filteroptional

JSON-encoded filter value consumed by RequestAPIData / API_DATA; specific actions may ignore it.

application/json

array
Schema-Beispiel
[
  {
    "property": "id",
    "expression": "=",
    "value": "permission_012345abcdef_123456"
  }
]
Array-Elemente
object
property string
expression string
value Typ nicht eingeschränkt

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

Vollständiges Schema als JSON
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "property": {
        "type": "string"
      },
      "expression": {
        "type": "string"
      },
      "value": {}
    },
    "additionalProperties": true
  },
  "examples": [
    [
      {
        "property": "id",
        "expression": "=",
        "value": "permission_012345abcdef_123456"
      }
    ]
  ]
}
Beispiel
[
  {
    "property": "id",
    "expression": "=",
    "value": "permission_012345abcdef_123456"
  }
]
limitoptional

JSON-encoded limit value consumed by RequestAPIData / API_DATA; specific actions may ignore it.

application/json

object
Schema-Beispiel
{
  "start": 0,
  "reply": 25
}
start integer
minimum
0

Standardwert: 0

reply integer
maximum
2000

Standardwert: 100

Vollständiges Schema als JSON
{
  "type": "object",
  "properties": {
    "start": {
      "type": "integer",
      "minimum": 0,
      "default": 0
    },
    "reply": {
      "type": "integer",
      "maximum": 2000,
      "default": 100
    }
  },
  "examples": [
    {
      "start": 0,
      "reply": 25
    }
  ]
}
Beispiel
{
  "start": 0,
  "reply": 25
}
orderoptional

JSON-encoded order value consumed by RequestAPIData / API_DATA; specific actions may ignore it.

application/json

array
Schema-Beispiel
[
  {
    "property": "id",
    "value": "ASC"
  }
]
Array-Elemente
object
property string
value string
Erlaubte Werte
"ASC""DESC"

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

Vollständiges Schema als JSON
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "property": {
        "type": "string"
      },
      "value": {
        "type": "string",
        "enum": [
          "ASC",
          "DESC"
        ]
      }
    },
    "additionalProperties": true
  },
  "examples": [
    [
      {
        "property": "id",
        "value": "ASC"
      }
    ]
  ]
}
Beispiel
[
  {
    "property": "id",
    "value": "ASC"
  }
]
response_typeoptional

Controls generic collection representation; default is an ID-keyed object.

string
Erlaubte Werte
"array""object"
Schema-Beispiel
"array"
Vollständiges Schema als JSON
{
  "type": "string",
  "enum": [
    "array",
    "object"
  ],
  "examples": [
    "array"
  ]
}

Header

languageoptional

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

string
Schema-Beispiel
"de"
Vollständiges Schema als JSON
{
  "type": "string",
  "examples": [
    "de"
  ]
}
04

Request Body

Kein Request Body in der Spezifikation beschrieben.

05

Antworten

9

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

200application/json

Response; inspect error and success as legacy failures may also use HTTP 200.

application/json

object
success boolean
error boolean | string
error_code string
data Typ nicht eingeschränkt

Generic collection (ID-keyed object by default, array for response_type=array) or resource object. Structure fields are partial and action-dependent.

anyOf · Mindestens eine Variante muss passen
Variante 1 object
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
"permission_012345abcdef_123456"
name string

Response field from the resource Structure; dynamic values remain unconstrained.

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-sourceLine": 35
}
acl integer

Response field from the resource Structure; dynamic values remain unconstrained.

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-sourceLine": 48
}
default boolean
Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Permission.php",
      "line": 66,
      "reason": "Structure declaration: input get, output set, persistence flags and field hooks.",
      "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
    },
    {
      "file": "application/models/v2/Permissionfunc.php",
      "line": 6,
      "reason": "Strict false branching and current default protection.",
      "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
    },
    {
      "file": "application/models/v2/Permissionfunc.php",
      "line": 38,
      "reason": "Account default lookup/fallback; source is read only for this review.",
      "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
    },
    {
      "file": "application/models/v2/Permissionfunc.php",
      "line": 83,
      "reason": "POST inserted default clears other account defaults.",
      "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
    },
    {
      "file": "application/models/v2/Permission.php",
      "line": 130,
      "reason": "Editable custom-permission target check before generic PUT.",
      "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
    },
    {
      "file": "application/models/v2/Permission.php",
      "line": 112,
      "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
      "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
    },
    {
      "file": "application/models/v2/Permission.php",
      "line": 130,
      "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
      "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
    },
    {
      "file": "docs/openapi/reviews/identity-fields.json",
      "line": 1,
      "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
      "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
    }
  ]
}
create_time Typ nicht eingeschränkt readOnly
anyOf · Mindestens eine Variante muss passen
Variante 1 string
format
"date-time"
Variante 2 Typ nicht eingeschränkt

Fester Wert: false

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Permission.php",
      "line": 76,
      "reason": "Structure declaration: input get, output set, persistence flags and field hooks.",
      "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
    },
    {
      "file": "application/models/v2/Permission.php",
      "line": 112,
      "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
      "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
    },
    {
      "file": "application/models/v2/Permission.php",
      "line": 130,
      "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
      "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
    },
    {
      "file": "docs/openapi/reviews/identity-fields.json",
      "line": 1,
      "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
      "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
    }
  ]
}

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

Variante 2 array
Array-Elemente
object
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
"permission_012345abcdef_123456"
name string

Response field from the resource Structure; dynamic values remain unconstrained.

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-sourceLine": 35
}
acl integer

Response field from the resource Structure; dynamic values remain unconstrained.

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-sourceLine": 48
}
default boolean
Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Permission.php",
      "line": 66,
      "reason": "Structure declaration: input get, output set, persistence flags and field hooks.",
      "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
    },
    {
      "file": "application/models/v2/Permissionfunc.php",
      "line": 6,
      "reason": "Strict false branching and current default protection.",
      "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
    },
    {
      "file": "application/models/v2/Permissionfunc.php",
      "line": 38,
      "reason": "Account default lookup/fallback; source is read only for this review.",
      "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
    },
    {
      "file": "application/models/v2/Permissionfunc.php",
      "line": 83,
      "reason": "POST inserted default clears other account defaults.",
      "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
    },
    {
      "file": "application/models/v2/Permission.php",
      "line": 130,
      "reason": "Editable custom-permission target check before generic PUT.",
      "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
    },
    {
      "file": "application/models/v2/Permission.php",
      "line": 112,
      "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
      "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
    },
    {
      "file": "application/models/v2/Permission.php",
      "line": 130,
      "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
      "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
    },
    {
      "file": "docs/openapi/reviews/identity-fields.json",
      "line": 1,
      "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
      "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
    }
  ]
}
create_time Typ nicht eingeschränkt readOnly
anyOf · Mindestens eine Variante muss passen
Variante 1 string
format
"date-time"
Variante 2 Typ nicht eingeschränkt

Fester Wert: false

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Permission.php",
      "line": 76,
      "reason": "Structure declaration: input get, output set, persistence flags and field hooks.",
      "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
    },
    {
      "file": "application/models/v2/Permission.php",
      "line": 112,
      "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
      "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
    },
    {
      "file": "application/models/v2/Permission.php",
      "line": 130,
      "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
      "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
    },
    {
      "file": "docs/openapi/reviews/identity-fields.json",
      "line": 1,
      "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
      "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
    }
  ]
}

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

Variante 3 object
Schema für zusätzliche Felder
object
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
"permission_012345abcdef_123456"
name string

Response field from the resource Structure; dynamic values remain unconstrained.

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-sourceLine": 35
}
acl integer

Response field from the resource Structure; dynamic values remain unconstrained.

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-sourceLine": 48
}
default boolean
Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Permission.php",
      "line": 66,
      "reason": "Structure declaration: input get, output set, persistence flags and field hooks.",
      "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
    },
    {
      "file": "application/models/v2/Permissionfunc.php",
      "line": 6,
      "reason": "Strict false branching and current default protection.",
      "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
    },
    {
      "file": "application/models/v2/Permissionfunc.php",
      "line": 38,
      "reason": "Account default lookup/fallback; source is read only for this review.",
      "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
    },
    {
      "file": "application/models/v2/Permissionfunc.php",
      "line": 83,
      "reason": "POST inserted default clears other account defaults.",
      "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
    },
    {
      "file": "application/models/v2/Permission.php",
      "line": 130,
      "reason": "Editable custom-permission target check before generic PUT.",
      "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
    },
    {
      "file": "application/models/v2/Permission.php",
      "line": 112,
      "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
      "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
    },
    {
      "file": "application/models/v2/Permission.php",
      "line": 130,
      "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
      "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
    },
    {
      "file": "docs/openapi/reviews/identity-fields.json",
      "line": 1,
      "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
      "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
    }
  ]
}
create_time Typ nicht eingeschränkt readOnly
anyOf · Mindestens eine Variante muss passen
Variante 1 string
format
"date-time"
Variante 2 Typ nicht eingeschränkt

Fester Wert: false

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Permission.php",
      "line": 76,
      "reason": "Structure declaration: input get, output set, persistence flags and field hooks.",
      "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
    },
    {
      "file": "application/models/v2/Permission.php",
      "line": 112,
      "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
      "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
    },
    {
      "file": "application/models/v2/Permission.php",
      "line": 130,
      "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
      "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
    },
    {
      "file": "docs/openapi/reviews/identity-fields.json",
      "line": 1,
      "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
      "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
    }
  ]
}

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": {
      "description": "Generic collection (ID-keyed object by default, array for response_type=array) or resource object. Structure fields are partial and action-dependent.",
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "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": [
                "permission_012345abcdef_123456"
              ]
            },
            "name": {
              "description": "Response field from the resource Structure; dynamic values remain unconstrained.",
              "x-edoobox-sourceLine": 35,
              "type": "string"
            },
            "acl": {
              "description": "Response field from the resource Structure; dynamic values remain unconstrained.",
              "x-edoobox-sourceLine": 48,
              "type": "integer"
            },
            "default": {
              "type": "boolean",
              "x-edoobox-contractSource": [
                {
                  "file": "application/models/v2/Permission.php",
                  "line": 66,
                  "reason": "Structure declaration: input get, output set, persistence flags and field hooks.",
                  "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                },
                {
                  "file": "application/models/v2/Permissionfunc.php",
                  "line": 6,
                  "reason": "Strict false branching and current default protection.",
                  "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
                },
                {
                  "file": "application/models/v2/Permissionfunc.php",
                  "line": 38,
                  "reason": "Account default lookup/fallback; source is read only for this review.",
                  "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
                },
                {
                  "file": "application/models/v2/Permissionfunc.php",
                  "line": 83,
                  "reason": "POST inserted default clears other account defaults.",
                  "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
                },
                {
                  "file": "application/models/v2/Permission.php",
                  "line": 130,
                  "reason": "Editable custom-permission target check before generic PUT.",
                  "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                },
                {
                  "file": "application/models/v2/Permission.php",
                  "line": 112,
                  "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                  "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                },
                {
                  "file": "application/models/v2/Permission.php",
                  "line": 130,
                  "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                  "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                },
                {
                  "file": "docs/openapi/reviews/identity-fields.json",
                  "line": 1,
                  "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                  "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
                }
              ]
            },
            "create_time": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "date-time"
                },
                {
                  "const": false
                }
              ],
              "readOnly": true,
              "x-edoobox-contractSource": [
                {
                  "file": "application/models/v2/Permission.php",
                  "line": 76,
                  "reason": "Structure declaration: input get, output set, persistence flags and field hooks.",
                  "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                },
                {
                  "file": "application/models/v2/Permission.php",
                  "line": 112,
                  "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                  "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                },
                {
                  "file": "application/models/v2/Permission.php",
                  "line": 130,
                  "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                  "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                },
                {
                  "file": "docs/openapi/reviews/identity-fields.json",
                  "line": 1,
                  "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                  "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
                }
              ]
            }
          },
          "additionalProperties": true
        },
        {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "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": [
                  "permission_012345abcdef_123456"
                ]
              },
              "name": {
                "description": "Response field from the resource Structure; dynamic values remain unconstrained.",
                "x-edoobox-sourceLine": 35,
                "type": "string"
              },
              "acl": {
                "description": "Response field from the resource Structure; dynamic values remain unconstrained.",
                "x-edoobox-sourceLine": 48,
                "type": "integer"
              },
              "default": {
                "type": "boolean",
                "x-edoobox-contractSource": [
                  {
                    "file": "application/models/v2/Permission.php",
                    "line": 66,
                    "reason": "Structure declaration: input get, output set, persistence flags and field hooks.",
                    "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                  },
                  {
                    "file": "application/models/v2/Permissionfunc.php",
                    "line": 6,
                    "reason": "Strict false branching and current default protection.",
                    "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
                  },
                  {
                    "file": "application/models/v2/Permissionfunc.php",
                    "line": 38,
                    "reason": "Account default lookup/fallback; source is read only for this review.",
                    "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
                  },
                  {
                    "file": "application/models/v2/Permissionfunc.php",
                    "line": 83,
                    "reason": "POST inserted default clears other account defaults.",
                    "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
                  },
                  {
                    "file": "application/models/v2/Permission.php",
                    "line": 130,
                    "reason": "Editable custom-permission target check before generic PUT.",
                    "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                  },
                  {
                    "file": "application/models/v2/Permission.php",
                    "line": 112,
                    "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                    "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                  },
                  {
                    "file": "application/models/v2/Permission.php",
                    "line": 130,
                    "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                    "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                  },
                  {
                    "file": "docs/openapi/reviews/identity-fields.json",
                    "line": 1,
                    "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                    "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
                  }
                ]
              },
              "create_time": {
                "anyOf": [
                  {
                    "type": "string",
                    "format": "date-time"
                  },
                  {
                    "const": false
                  }
                ],
                "readOnly": true,
                "x-edoobox-contractSource": [
                  {
                    "file": "application/models/v2/Permission.php",
                    "line": 76,
                    "reason": "Structure declaration: input get, output set, persistence flags and field hooks.",
                    "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                  },
                  {
                    "file": "application/models/v2/Permission.php",
                    "line": 112,
                    "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                    "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                  },
                  {
                    "file": "application/models/v2/Permission.php",
                    "line": 130,
                    "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                    "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                  },
                  {
                    "file": "docs/openapi/reviews/identity-fields.json",
                    "line": 1,
                    "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                    "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
                  }
                ]
              }
            },
            "additionalProperties": true
          }
        },
        {
          "type": "object",
          "additionalProperties": {
            "type": "object",
            "properties": {
              "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": [
                  "permission_012345abcdef_123456"
                ]
              },
              "name": {
                "description": "Response field from the resource Structure; dynamic values remain unconstrained.",
                "x-edoobox-sourceLine": 35,
                "type": "string"
              },
              "acl": {
                "description": "Response field from the resource Structure; dynamic values remain unconstrained.",
                "x-edoobox-sourceLine": 48,
                "type": "integer"
              },
              "default": {
                "type": "boolean",
                "x-edoobox-contractSource": [
                  {
                    "file": "application/models/v2/Permission.php",
                    "line": 66,
                    "reason": "Structure declaration: input get, output set, persistence flags and field hooks.",
                    "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                  },
                  {
                    "file": "application/models/v2/Permissionfunc.php",
                    "line": 6,
                    "reason": "Strict false branching and current default protection.",
                    "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
                  },
                  {
                    "file": "application/models/v2/Permissionfunc.php",
                    "line": 38,
                    "reason": "Account default lookup/fallback; source is read only for this review.",
                    "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
                  },
                  {
                    "file": "application/models/v2/Permissionfunc.php",
                    "line": 83,
                    "reason": "POST inserted default clears other account defaults.",
                    "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
                  },
                  {
                    "file": "application/models/v2/Permission.php",
                    "line": 130,
                    "reason": "Editable custom-permission target check before generic PUT.",
                    "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                  },
                  {
                    "file": "application/models/v2/Permission.php",
                    "line": 112,
                    "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                    "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                  },
                  {
                    "file": "application/models/v2/Permission.php",
                    "line": 130,
                    "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                    "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                  },
                  {
                    "file": "docs/openapi/reviews/identity-fields.json",
                    "line": 1,
                    "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                    "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
                  }
                ]
              },
              "create_time": {
                "anyOf": [
                  {
                    "type": "string",
                    "format": "date-time"
                  },
                  {
                    "const": false
                  }
                ],
                "readOnly": true,
                "x-edoobox-contractSource": [
                  {
                    "file": "application/models/v2/Permission.php",
                    "line": 76,
                    "reason": "Structure declaration: input get, output set, persistence flags and field hooks.",
                    "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                  },
                  {
                    "file": "application/models/v2/Permission.php",
                    "line": 112,
                    "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                    "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                  },
                  {
                    "file": "application/models/v2/Permission.php",
                    "line": 130,
                    "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                    "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                  },
                  {
                    "file": "docs/openapi/reviews/identity-fields.json",
                    "line": 1,
                    "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                    "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
                  }
                ]
              }
            },
            "additionalProperties": true
          }
        }
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
Beispiel
{
  "success": true,
  "error": false,
  "data": {
    "permission_012345abcdef_123456": {
      "id": "permission_012345abcdef_123456"
    }
  },
  "limit": {
    "start": 0,
    "reply": 100,
    "total": 1
  }
}
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"
}
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"
}
06

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Permission.php:227getPermission()

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
false
x-edoobox-runtimeMutationGuard
false
x-edoobox-get-effect
"read"
x-edoobox-documentationReview
{
  "file": "docs/openapi/operation-contracts/05-auth.json",
  "notes": []
}
x-edoobox-source
{
  "file": "application/models/v2/Permission.php",
  "method": "getPermission",
  "line": 227
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
true
x-edoobox-safeForAutomation
true
x-edoobox-permission
{
  "resource": "permission",
  "short": "perm",
  "checkedByDispatcher": true,
  "levels": [
    1,
    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": "get_v2_permission_id",
  "summary": "Berechtigungsprofil lesen",
  "description": "Liest das durch die öffentliche Pfad-ID gewählte Berechtigungsprofil. Auch ein Einzelabruf liefert die normale GET-Datenstruktur; Feldauswahl, Filter und Konto-Berechtigungen bleiben wirksam.",
  "tags": [
    "permission"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "description": "v2 object identifier in the selected account.",
      "schema": {
        "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": [
          "permission_012345abcdef_123456"
        ]
      }
    },
    {
      "name": "fields",
      "in": "query",
      "required": false,
      "description": "JSON-encoded fields value consumed by RequestAPIData / API_DATA; specific actions may ignore it.",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "examples": [
              [
                "id"
              ]
            ]
          },
          "example": [
            "id"
          ]
        }
      }
    },
    {
      "name": "filter",
      "in": "query",
      "required": false,
      "description": "JSON-encoded filter value consumed by RequestAPIData / API_DATA; specific actions may ignore it.",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "property": {
                  "type": "string"
                },
                "expression": {
                  "type": "string"
                },
                "value": {}
              },
              "additionalProperties": true
            },
            "examples": [
              [
                {
                  "property": "id",
                  "expression": "=",
                  "value": "permission_012345abcdef_123456"
                }
              ]
            ]
          },
          "example": [
            {
              "property": "id",
              "expression": "=",
              "value": "permission_012345abcdef_123456"
            }
          ]
        }
      }
    },
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "JSON-encoded limit value consumed by RequestAPIData / API_DATA; specific actions may ignore it.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "start": {
                "type": "integer",
                "minimum": 0,
                "default": 0
              },
              "reply": {
                "type": "integer",
                "maximum": 2000,
                "default": 100
              }
            },
            "examples": [
              {
                "start": 0,
                "reply": 25
              }
            ]
          },
          "example": {
            "start": 0,
            "reply": 25
          }
        }
      }
    },
    {
      "name": "order",
      "in": "query",
      "required": false,
      "description": "JSON-encoded order value consumed by RequestAPIData / API_DATA; specific actions may ignore it.",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "property": {
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "enum": [
                    "ASC",
                    "DESC"
                  ]
                }
              },
              "additionalProperties": true
            },
            "examples": [
              [
                {
                  "property": "id",
                  "value": "ASC"
                }
              ]
            ]
          },
          "example": [
            {
              "property": "id",
              "value": "ASC"
            }
          ]
        }
      }
    },
    {
      "name": "response_type",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "array",
          "object"
        ],
        "examples": [
          "array"
        ]
      },
      "description": "Controls generic collection representation; default is an ID-keyed object."
    },
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Response; inspect error and success as legacy failures may also use HTTP 200.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "permission_012345abcdef_123456": {
                "id": "permission_012345abcdef_123456"
              }
            },
            "limit": {
              "start": 0,
              "reply": 100,
              "total": 1
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "description": "Generic collection (ID-keyed object by default, array for response_type=array) or resource object. Structure fields are partial and action-dependent.",
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "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": [
                          "permission_012345abcdef_123456"
                        ]
                      },
                      "name": {
                        "description": "Response field from the resource Structure; dynamic values remain unconstrained.",
                        "x-edoobox-sourceLine": 35,
                        "type": "string"
                      },
                      "acl": {
                        "description": "Response field from the resource Structure; dynamic values remain unconstrained.",
                        "x-edoobox-sourceLine": 48,
                        "type": "integer"
                      },
                      "default": {
                        "type": "boolean",
                        "x-edoobox-contractSource": [
                          {
                            "file": "application/models/v2/Permission.php",
                            "line": 66,
                            "reason": "Structure declaration: input get, output set, persistence flags and field hooks.",
                            "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                          },
                          {
                            "file": "application/models/v2/Permissionfunc.php",
                            "line": 6,
                            "reason": "Strict false branching and current default protection.",
                            "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
                          },
                          {
                            "file": "application/models/v2/Permissionfunc.php",
                            "line": 38,
                            "reason": "Account default lookup/fallback; source is read only for this review.",
                            "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
                          },
                          {
                            "file": "application/models/v2/Permissionfunc.php",
                            "line": 83,
                            "reason": "POST inserted default clears other account defaults.",
                            "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
                          },
                          {
                            "file": "application/models/v2/Permission.php",
                            "line": 130,
                            "reason": "Editable custom-permission target check before generic PUT.",
                            "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                          },
                          {
                            "file": "application/models/v2/Permission.php",
                            "line": 112,
                            "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                            "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                          },
                          {
                            "file": "application/models/v2/Permission.php",
                            "line": 130,
                            "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                            "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                          },
                          {
                            "file": "docs/openapi/reviews/identity-fields.json",
                            "line": 1,
                            "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                            "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
                          }
                        ]
                      },
                      "create_time": {
                        "anyOf": [
                          {
                            "type": "string",
                            "format": "date-time"
                          },
                          {
                            "const": false
                          }
                        ],
                        "readOnly": true,
                        "x-edoobox-contractSource": [
                          {
                            "file": "application/models/v2/Permission.php",
                            "line": 76,
                            "reason": "Structure declaration: input get, output set, persistence flags and field hooks.",
                            "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                          },
                          {
                            "file": "application/models/v2/Permission.php",
                            "line": 112,
                            "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                            "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                          },
                          {
                            "file": "application/models/v2/Permission.php",
                            "line": 130,
                            "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                            "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                          },
                          {
                            "file": "docs/openapi/reviews/identity-fields.json",
                            "line": 1,
                            "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                            "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
                          }
                        ]
                      }
                    },
                    "additionalProperties": true
                  },
                  {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "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": [
                            "permission_012345abcdef_123456"
                          ]
                        },
                        "name": {
                          "description": "Response field from the resource Structure; dynamic values remain unconstrained.",
                          "x-edoobox-sourceLine": 35,
                          "type": "string"
                        },
                        "acl": {
                          "description": "Response field from the resource Structure; dynamic values remain unconstrained.",
                          "x-edoobox-sourceLine": 48,
                          "type": "integer"
                        },
                        "default": {
                          "type": "boolean",
                          "x-edoobox-contractSource": [
                            {
                              "file": "application/models/v2/Permission.php",
                              "line": 66,
                              "reason": "Structure declaration: input get, output set, persistence flags and field hooks.",
                              "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                            },
                            {
                              "file": "application/models/v2/Permissionfunc.php",
                              "line": 6,
                              "reason": "Strict false branching and current default protection.",
                              "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
                            },
                            {
                              "file": "application/models/v2/Permissionfunc.php",
                              "line": 38,
                              "reason": "Account default lookup/fallback; source is read only for this review.",
                              "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
                            },
                            {
                              "file": "application/models/v2/Permissionfunc.php",
                              "line": 83,
                              "reason": "POST inserted default clears other account defaults.",
                              "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
                            },
                            {
                              "file": "application/models/v2/Permission.php",
                              "line": 130,
                              "reason": "Editable custom-permission target check before generic PUT.",
                              "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                            },
                            {
                              "file": "application/models/v2/Permission.php",
                              "line": 112,
                              "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                              "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                            },
                            {
                              "file": "application/models/v2/Permission.php",
                              "line": 130,
                              "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                              "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                            },
                            {
                              "file": "docs/openapi/reviews/identity-fields.json",
                              "line": 1,
                              "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                              "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
                            }
                          ]
                        },
                        "create_time": {
                          "anyOf": [
                            {
                              "type": "string",
                              "format": "date-time"
                            },
                            {
                              "const": false
                            }
                          ],
                          "readOnly": true,
                          "x-edoobox-contractSource": [
                            {
                              "file": "application/models/v2/Permission.php",
                              "line": 76,
                              "reason": "Structure declaration: input get, output set, persistence flags and field hooks.",
                              "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                            },
                            {
                              "file": "application/models/v2/Permission.php",
                              "line": 112,
                              "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                              "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                            },
                            {
                              "file": "application/models/v2/Permission.php",
                              "line": 130,
                              "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                              "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                            },
                            {
                              "file": "docs/openapi/reviews/identity-fields.json",
                              "line": 1,
                              "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                              "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
                            }
                          ]
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": {
                      "type": "object",
                      "properties": {
                        "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": [
                            "permission_012345abcdef_123456"
                          ]
                        },
                        "name": {
                          "description": "Response field from the resource Structure; dynamic values remain unconstrained.",
                          "x-edoobox-sourceLine": 35,
                          "type": "string"
                        },
                        "acl": {
                          "description": "Response field from the resource Structure; dynamic values remain unconstrained.",
                          "x-edoobox-sourceLine": 48,
                          "type": "integer"
                        },
                        "default": {
                          "type": "boolean",
                          "x-edoobox-contractSource": [
                            {
                              "file": "application/models/v2/Permission.php",
                              "line": 66,
                              "reason": "Structure declaration: input get, output set, persistence flags and field hooks.",
                              "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                            },
                            {
                              "file": "application/models/v2/Permissionfunc.php",
                              "line": 6,
                              "reason": "Strict false branching and current default protection.",
                              "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
                            },
                            {
                              "file": "application/models/v2/Permissionfunc.php",
                              "line": 38,
                              "reason": "Account default lookup/fallback; source is read only for this review.",
                              "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
                            },
                            {
                              "file": "application/models/v2/Permissionfunc.php",
                              "line": 83,
                              "reason": "POST inserted default clears other account defaults.",
                              "sha256": "feacb9fc50ad276cd80c86f5ddb8f07176365a6aeda494d64a7b594080e0bf70"
                            },
                            {
                              "file": "application/models/v2/Permission.php",
                              "line": 130,
                              "reason": "Editable custom-permission target check before generic PUT.",
                              "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                            },
                            {
                              "file": "application/models/v2/Permission.php",
                              "line": 112,
                              "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                              "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                            },
                            {
                              "file": "application/models/v2/Permission.php",
                              "line": 130,
                              "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                              "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                            },
                            {
                              "file": "docs/openapi/reviews/identity-fields.json",
                              "line": 1,
                              "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                              "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
                            }
                          ]
                        },
                        "create_time": {
                          "anyOf": [
                            {
                              "type": "string",
                              "format": "date-time"
                            },
                            {
                              "const": false
                            }
                          ],
                          "readOnly": true,
                          "x-edoobox-contractSource": [
                            {
                              "file": "application/models/v2/Permission.php",
                              "line": 76,
                              "reason": "Structure declaration: input get, output set, persistence flags and field hooks.",
                              "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                            },
                            {
                              "file": "application/models/v2/Permission.php",
                              "line": 112,
                              "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                              "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                            },
                            {
                              "file": "application/models/v2/Permission.php",
                              "line": 130,
                              "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                              "sha256": "61d1a74f5ffce21d1eaddfe65588fd6bb8b809d63e748a7536765e66ad7abead"
                            },
                            {
                              "file": "docs/openapi/reviews/identity-fields.json",
                              "line": 1,
                              "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                              "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
                            }
                          ]
                        }
                      },
                      "additionalProperties": true
                    }
                  }
                ]
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      }
    },
    "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"
          }
        }
      }
    },
    "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"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": false,
  "x-edoobox-runtimeMutationGuard": false,
  "x-edoobox-get-effect": "read",
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/05-auth.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Permission.php",
    "method": "getPermission",
    "line": 227
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": true,
  "x-edoobox-safeForAutomation": true,
  "x-edoobox-permission": {
    "resource": "permission",
    "short": "perm",
    "checkedByDispatcher": true,
    "levels": [
      1,
      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."
  }
}
Cookies & Datenschutz
Notwendig

Für Sicherheit, Navigation, Formulare und den technischen Betrieb der Website.

Immer aktiv
Datenschutzerklärung