API-V2 REST Header-Modifier

Header-Modifiers

Header-Name

Values

Default

Description

X-ExplodeFlatChainProperties

true / false

true

true: Chain-Properties are returned as a nested object

false: Chain-Properties are returned as a single object (period name)

X-AccessDeniedReplacement

[String]

If a value is set, AccessDenied handlers are replaced by its value. In the event of violation of rights, the header value is returned as a string instead (This option is not type-safe because a string is always returned in the event of an access denial, regardless of the original type of the property)

Examples

Standard

GET /servicedmcore/CoreIdentity/20?fields=id,foreign_id,ci_given_name,foreign_id,ci_given_name,core_identity_type.id

{
    "ci_city": {
        "was_access_denied": true,
        "value": null
    },
    "ci_given_name": {
        "was_access_denied": false,
        "value": "Hansueli"
    },
    "foreign_id": "TestForeignId",
    "id": 20,
    "core_identity_type": {
        "id": {
            "was_access_denied": false,
            "value": 1
        }
    }
}

FlatChain

GET /servicedmcore/CoreIdentity/20?fields=id,foreign_id,ci_given_name,foreign_id,ci_given_name,core_identity_type.id
--header 'X-ExplodeFlatChainProperties: false'

{
    "ci_city": {
        "was_access_denied": true,
        "value": null
    },
    "ci_given_name": {
        "was_access_denied": false,
        "value": "Hansueli"
    },
    "core_identity_type.id": {
        "was_access_denied": false,
        "value": 1
    },
    "foreign_id": "TestForeignId",
    "id": 20
}

AccessDeniedReplacement

GET /servicedmcore/CoreIdentity/20?fields=id,foreign_id,ci_given_name,foreign_id,ci_given_name,core_identity_type.id
--header 'X-AccessDeniedReplacement: >>AccessDenied<<'

{
    "ci_city": ">>AccessDenied<<",
    "ci_given_name": "Hansueli",
    "foreign_id": "TestForeignId",
    "id": 20,
    "core_identity_type": {
        "id": 1
    }
}

Combination

GET /servicedmcore/CoreIdentity/20?fields=id,foreign_id,ci_given_name,foreign_id,ci_given_name,core_identity_type.id
--header 'X-ExplodeFlatChainProperties: false'
--header 'X-AccessDeniedReplacement: >>AccessDenied<<'

{
    "ci_city": ">>AccessDenied<<",
    "ci_given_name": "Hansueli",
    "core_identity_type.id": 1,
    "foreign_id": "TestForeignId",
    "id": 20
}