VNG-Realisatie / gemma-zaken

Samen ontwikkelen van API's voor Zaakgericht werken
https://vng-realisatie.github.io/gemma-zaken/
Other
41 stars 26 forks source link

ZRC: Expand op eigenschap mogelijk maken #2411

Closed johannesbattjes closed 4 months ago

johannesbattjes commented 4 months ago

Nu is een expand op https://zaken-api.test.vng.cloud/api/v1/zaken/{zaak_uuid}/zaakeigenschappen/{uuid} niet mogelijk. Het zou wel handig zijn om de eiegnschapspecificaties uit de ZTC hierbij te kunnen bevragen, met name vanwege het formaat.

@HenriKorver

johannesbattjes commented 4 months ago

Hetzelfde geldt voor de bevraging van zaak met expand=eigenschappen.eigenschap

HenriKorver commented 4 months ago

Hetzelfde geldt voor de bevraging van zaak met expand=eigenschappen.eigenschap

Vreemd, bij mij werkt deze bevraging wel.

GET https://zaken-api.test.vng.cloud/api/v1/zaken/9b3c316b-c33b-4c48-9893-41f57f62f596?expand=eigenschappen.eigenschap

geeft het volgende resultaat:

{
    "url": "https://zaken-api.test.vng.cloud/api/v1/zaken/9b3c316b-c33b-4c48-9893-41f57f62f596",
    "uuid": "9b3c316b-c33b-4c48-9893-41f57f62f596",
    "identificatie": "ZAAK-2019-0000000008",
    "bronorganisatie": "000000000",
    "omschrijving": "aangepast",
    "toelichting": "string",
    "zaaktype": "https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/5f1dbfe1-23d0-4dd5-b88a-1faca8ef02a1",
    "registratiedatum": "2019-04-09",
    "verantwoordelijkeOrganisatie": "000000000",
    "startdatum": "2019-04-09",
    "einddatum": null,
    "einddatumGepland": "2019-04-20",
    "uiterlijkeEinddatumAfdoening": "2019-04-09",
    "publicatiedatum": "2019-04-09",
    "communicatiekanaal": "",
    "productenOfDiensten": [],
    "vertrouwelijkheidaanduiding": "openbaar",
    "betalingsindicatie": "geheel",
    "betalingsindicatieWeergave": "De met de zaak gemoeide kosten zijn geheel betaald.",
    "laatsteBetaaldatum": null,
    "zaakgeometrie": {
        "type": "Point",
        "coordinates": [
            53.0,
            5.0
        ]
    },
    "verlenging": {
        "reden": "",
        "duur": null
    },
    "opschorting": {
        "indicatie": true,
        "reden": "string"
    },
    "selectielijstklasse": "https://referentielijsten-api.vng.cloud/api/v1/resultaten/fb65ae34-e820-4ace-815a-cf5da7d04a12",
    "hoofdzaak": null,
    "deelzaken": [],
    "relevanteAndereZaken": [],
    "eigenschappen": [
        "https://zaken-api.test.vng.cloud/api/v1/zaken/9b3c316b-c33b-4c48-9893-41f57f62f596/zaakeigenschappen/11e70141-d288-4f21-b999-c46f901f1968",
        "https://zaken-api.test.vng.cloud/api/v1/zaken/9b3c316b-c33b-4c48-9893-41f57f62f596/zaakeigenschappen/f7039465-a23f-42f8-811f-0b03f66816a6"
    ],
    "rollen": [],
    "status": null,
    "zaakinformatieobjecten": [],
    "zaakobjecten": [],
    "kenmerken": [],
    "archiefnominatie": null,
    "archiefstatus": "nog_te_archiveren",
    "archiefactiedatum": null,
    "resultaat": null,
    "opdrachtgevendeOrganisatie": "",
    "processobjectaard": null,
    "startdatumBewaartermijn": null,
    "processobject": {
        "datumkenmerk": "",
        "identificatie": "",
        "objecttype": "",
        "registratie": ""
    },
    "_expand": {
        "eigenschappen": [
            {
                "url": "https://zaken-api.test.vng.cloud/api/v1/zaken/9b3c316b-c33b-4c48-9893-41f57f62f596/zaakeigenschappen/11e70141-d288-4f21-b999-c46f901f1968",
                "uuid": "11e70141-d288-4f21-b999-c46f901f1968",
                "zaak": "https://zaken-api.test.vng.cloud/api/v1/zaken/9b3c316b-c33b-4c48-9893-41f57f62f596",
                "eigenschap": "https://catalogi-api.test.vng.cloud/api/v1/eigenschappen/15fe64b4-7b67-451a-9657-caebb31d88c9",
                "naam": "test eigenschap",
                "waarde": "test",
                "_expand": {
                    "eigenschap": {
                        "url": "https://catalogi-api.test.vng.cloud/api/v1/eigenschappen/15fe64b4-7b67-451a-9657-caebb31d88c9",
                        "naam": "test eigenschap",
                        "catalogus": "https://catalogi-api.test.vng.cloud/api/v1/catalogussen/7c7bdc43-478f-4410-b08c-85ee79b058ae",
                        "definitie": "for test",
                        "specificatie": {
                            "groep": "",
                            "formaat": "tekst",
                            "lengte": "5",
                            "kardinaliteit": "1",
                            "waardenverzameling": [
                                "test"
                            ]
                        },
                        "toelichting": "",
                        "zaaktype": "https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/5f1dbfe1-23d0-4dd5-b88a-1faca8ef02a1",
                        "zaaktypeIdentificatie": "35eb40f2-a60a-4249-870d-8b09321bf183",
                        "statustype": null,
                        "beginGeldigheid": null,
                        "eindeGeldigheid": null,
                        "beginObject": null,
                        "eindeObject": null
                    }
                }
            },
            {
                "url": "https://zaken-api.test.vng.cloud/api/v1/zaken/9b3c316b-c33b-4c48-9893-41f57f62f596/zaakeigenschappen/f7039465-a23f-42f8-811f-0b03f66816a6",
                "uuid": "f7039465-a23f-42f8-811f-0b03f66816a6",
                "zaak": "https://zaken-api.test.vng.cloud/api/v1/zaken/9b3c316b-c33b-4c48-9893-41f57f62f596",
                "eigenschap": "https://catalogi-api.test.vng.cloud/api/v1/eigenschappen/15fe64b4-7b67-451a-9657-caebb31d88c9",
                "naam": "test eigenschap",
                "waarde": "test",
                "_expand": {
                    "eigenschap": {
                        "url": "https://catalogi-api.test.vng.cloud/api/v1/eigenschappen/15fe64b4-7b67-451a-9657-caebb31d88c9",
                        "naam": "test eigenschap",
                        "catalogus": "https://catalogi-api.test.vng.cloud/api/v1/catalogussen/7c7bdc43-478f-4410-b08c-85ee79b058ae",
                        "definitie": "for test",
                        "specificatie": {
                            "groep": "",
                            "formaat": "tekst",
                            "lengte": "5",
                            "kardinaliteit": "1",
                            "waardenverzameling": [
                                "test"
                            ]
                        },
                        "toelichting": "",
                        "zaaktype": "https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/5f1dbfe1-23d0-4dd5-b88a-1faca8ef02a1",
                        "zaaktypeIdentificatie": "35eb40f2-a60a-4249-870d-8b09321bf183",
                        "statustype": null,
                        "beginGeldigheid": null,
                        "eindeGeldigheid": null,
                        "beginObject": null,
                        "eindeObject": null
                    }
                }
            }
        ]
    }
}
HenriKorver commented 4 months ago

Wat betreft je eerste vraag:

Nu is een expand op https://zaken-api.test.vng.cloud/api/v1/zaken/{zaak_uuid}/zaakeigenschappen/{uuid} niet mogelijk. Het zou wel handig zijn om de eiegnschapspecificaties uit de ZTC hierbij te kunnen bevragen, met name vanwege het formaat.

Expand is niet gedefinieerd op de subresources van de zaak (zie ook de OAS). Je kunt subresources zoals eigenschappen, rollen, etc., alleen expanden via de gelijknamige attributen van de zaak zelf.

Dus als je in /zaken/{uuid}/eigenschappen het veld "eigenschap" wilt expanden dan doe je dat zo via de zaak:

GET /zaken/{uuid}?expand=eigenschappen.eigenschap

johannesbattjes commented 4 months ago

Ok prima dank voor de toelichting