API-V2 REST Read objects

Simple query of a single object with standard properties

GET /servicedmcore/CoreIdentity/20

{
    "active": true,
    "foreign_id": "mssql_113",
    "id": 20,
    "manager_id": null,
    "readonly_display_name": "Wiwoldi Wawrinka",
    "tenant_id": 1,
    "valid_from": "2017-01-01T00:00:00Z",
    "valid_to": null
}

Query of a single object with extended properties

Siehe "Abfragen aller verfügbaren Felder eines Objekt-Types"

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

{
    "active": true,
    "ci_family_name": {
        "was_access_denied": false,
        "value": "Wawrinka"
    },
    "ci_given_name": {
        "was_access_denied": false,
        "value": "Wiwoldi"
    },
    "ci_private_address_line_1": {
        "was_access_denied": false,
        "value": "Bahnhofplatz 3h"
    },
    "foreign_id": "mssql_113",
    "id": 20,
    "core_identity_type": {
        "id": {
            "was_access_denied": false,
            "value": 1
        }
    }
}

Query of a single object with DropDown-Attribute-Values

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

{
    "active": true,
    "ci_given_name": {
        "was_access_denied": false,
        "value": "Hansueli"
    },
    "foreign_id": "TestForeignId",
    "g_language": {
        "was_access_denied": false,
        "value": {
            "drop_down_definition_id": 21,
            "drop_down_value": 7,
            "display_name": "Deutsch",
            "name_key": "Module.GeneralSetting.Setting.Language.German",
            "translation": "Deutsch"
        }
    },
    "id": 20,
    "core_identity_type": {
        "id": {
            "was_access_denied": false,
            "value": 1
        }
    }
}

Simple query of a list of objects with standard properties

GET /servicedmcore/CoreIdentity

[
    {
        "active": true,
        "foreign_id": "mssql_1",
        "id": 1,
        "manager_id": null,
        "readonly_display_name": "Simon Gubler",
        "tenant_id": 1,
        "valid_from": "2010-03-01T00:00:00Z",
        "valid_to": null
    },
    {
        "active": false,
        "foreign_id": "mssql_todelete",
        "id": 2,
        "manager_id": null,
        "readonly_display_name": "Marc Burkhard",
        "tenant_id": 1,
        "valid_from": "2014-05-30T00:00:00Z",
        "valid_to": null
    },
    ...
]

Query a filtered list of objects with extended properties

Siehe "Abfragen aller verfügbaren Felder eines Objekt-Types"

GET /servicedmcore/CoreIdentity
?fields=Id,Vorname,Nachname,CoreIdentityType.Id
&filter=Vorname startsWith M
&take=30
&totalcount=true

[
    {
        "active": true,
        "foreign_id": "mssql_1",
        "id": 1,
        "manager_id": null,
        "readonly_display_name": "Simon Gubler",
        "tenant_id": 1,
        "valid_from": "2010-03-01T00:00:00Z",
        "valid_to": null
    },
    {
        "active": false,
        "foreign_id": "mssql_todelete",
        "id": 2,
        "manager_id": null,
        "readonly_display_name": "Marc Burkhard",
        "tenant_id": 1,
        "valid_from": "2014-05-30T00:00:00Z",
        "valid_to": null
    },
    ...
]

CoreOne Suite Dokumentation

API-V2 REST Read objects

Simple query of a single object with standard properties

Query of a single object with extended properties

Query of a single object with DropDown-Attribute-Values

Simple query of a list of objects with standard properties

Query a filtered list of objects with extended properties

Related content