Releasedatum: 1 juni 2023
Dit artikel beschrijft de wijzigingen ten opzichte van de vorige versie van de API.
Voor meer informatie over de API kunt u de specificatie downloaden.
Inhoudsopgave
Download de Open API-specificatie en regenereer uw API-bibliotheek
Algemeen
Het versienummer van deze release van de API is niet bijgewerkt. Toch is er een wat veranderd in deze versie. Die veranderingen zijn in deze releasenotes beschreven.
De aanwezigheid van de beschrijving van de Entity Metadata geeft aan het gaat om de versie die vanaf 1 juni beschikbaar is.
Verbeteringen
Endpoints:
GET /api/v1/engagements, GET /api/v1/engagements/custombundles/{engagementId}
Verbetering: EenEngagementGuid
veld toegevoegd om API's die de SE-versie van de GUID van een opdracht bevatten. Dit veld kan worden gebruikt als zoekterm om de opdracht in SE te lokaliseren.
Endpoints:
GET /api/v1/engagements, GET /api/v1/engagements/custombundles/{engagementId}
Veld: EntityMetadata
Verbetering: EntityMetadata
veld toegevoegd om API's in Collaborate die een SE-versie van de GUID van een opdracht bevatten. Dit wordt gebruikt voor de identificatie van de juiste opdrachten voor beveiliging en rechten.
Endpoints:
PUT /api/v1/entities/{entityId}/metadata/{context}
Verbetering: Entiteiten API's bevatten nu speciale velden die voorheen niet zichtbaar waren, zoals Statutaire vestigingsplaats. De nieuwe API kan worden gebruikt om waarden in de velden EntityMetadata
te wijzigen.
Oplossingen
Endpoints:
POST/PATCH /api/v1/groups, POST/PATCH /api/v1/entities
Probleem: De endpoints /groups
/entities
geven een onbekende fout (Fout 500) na een update van Cloud API 1.3.1.
Oplossing: Het veld hernoemd naar OwnerType
om te matchen met de interne controllerparameter.
Endpoints:
GET /api/v1/users, GET /api/v1/groups, GET /api/v1/engagements
Veld: Type
Probleem: Het Type
veld voor beveiligingsgroepen is niet uniform tussen endpoints.
Oplossing: Renamed the field to OwnerType
to match the internal controller parameter.
Download de Open API-specificatie en regenereer uw API-bibliotheek
Om de nieuwste Cloud API-wijzigingen te krijgen:
- Ga in je browser naar deze URL:
https://nl.casewarecloud.com/<firm>/sdk
- Selecteer aan de linkerkant /caseware-cloud.
- Controleer of de versie Caseware Cloud API 1.6.0 en selecteer Downloaden.
- Neem het gedownloade api.json bestand en gebruik het om uw API-bibliotheek te regenereren.