API-Änderungen für Drittentwickler

Mit dieser Version führen wir API-Dokumentation auf der Grundlage von OpenAPI ein. Sie ist im computerlesbaren OpenAPI json-Format verfügbar und kann für die automatisierte Endpunkt-Erkennung verwendet werden.

Die für die gesamte Rest API verfügbare Dokumentation finden Sie unter: http(s)://<gserver>/docs/<section>, wobei <gsserver> der Host-Server ist und <section> Folgendes sein kann:

  • supported – enthält alle unterstützten Endpunkte. Dies ist das empfohlene Dokument für die regelmäßige Verwendung.
  • all – enthält alle Endpunkte, einschließlich veralteter.
  • V4 – enthält nur Endpunkte, die zu Version 4 gehören.
  • V3 – enthält nur Endpunkte, die zu Version 3 gehören.
  • V2 – enthält nur Endpunkte, die zu Version 2 gehören.
  • V1 – enthält nur Endpunkte, die zu Version 1 gehören. Diese Endpunkte sind für Projektserver und Management veraltet.
Bestimmte Programmierschnittstellen finden Sie unter den folgenden Links:
  • http(s)://<gserver>/docs/projectserver/<section>
  • http(s)://<gserver>/docs/management/<section>
  • http(s)://<gserver>/docs/multiterm/<section>
  • http(s)://<gserver>/docs/authentication/<section>

In den Links oben gilt:

  • <gserver> ist der Hostserver.
  • <section> kann all sein (enthält alle verfügbaren Endpunkte) oder supported (enthält nur nicht veraltete Endpunkte).

Veraltete Endpunkte

Wir haben die folgenden REST API-Endpunkte als veraltet markiert und planen, sie in zukünftigen Versionen zu entfernen:

Http-MethodeVeraltete RoutenAlternativeGrund
GET/api/management/v2/backgroundtasks/{id}/api/management/v2/backgroundtasks-
POST/api/management/v2/organizationcals/{organizationid}/api/management/v2/organizationcals-
PUT/api/management/v2/organizationresources/{id}/api/management/v2/organizationresources-
DELETE/api/management/v2/organizations/api/management/v2/organizations/{id}-
POST/api/management/v2/organizations/{id}/api/management/v2/organizations-
PUT/api/management/v2/organizations/{id}/api/management/v2/organizations-
DELETE/api/management/v2/organizations/{organizationId}/membership/api/management/v2/organizations/{id}-
POST/api/management/v2/organizations/{organizationId}/membership/api/management/v2/organizations-
PUT/api/management/v2/organizations/{organizationId}/membership/api/management/v2/organizations-
POST/api/management/v2/roles/{id}/api/management/v2/roles-
PUT/api/management/v2/roles/{id}/api/management/v2/roles-
DELETE/api/management/v2/roles/{roleId}/membership/api/management/v2/roles/membership-
GET/api/management/v2/roles/{roleId}/membership/api/management/v2/roles/{roleId}/users-
PUT/api/management/v2/roles/{roleId}/membership/api/management/v2/roles/membership-
PUT/api/management/v2/roles/{roleId}/users/api/management/v2/roles/membership-
DELETE/api/management/v2/roles/membership/{id}/api/management/v2/roles/membership-
GET/api/management/v2/roles/membership/{id}/api/management/v2/roles/{roleId}/users-
PUT/api/management/v2/roles/membership/{id}/api/management/v2/roles/membership-
POST/api/management/v2/users/{id}/api/management/v2/users-
PUT/api/management/v2/users/{id}/api/management/v2/users-
DELETE/api/management/v2/users/{name}/api/management/v2/users/{id}-
POST/api/management/v2/users/{name}/api/management/v2/users-
PUT/api/management/v2/users/{name}/api/management/v2/users-
POST/api/management/v3/organizations/{id}/api/management/v3/organizations-
PUT/api/management/v3/organizations/{id}/api/management/v3/organizations-
GET/api/projectserver/v2/dashboard--
GET/api/projectserver/v2/dashboard/projectsPerMonthReporting-Dienst /api/reports/Dashboard/ProjectsPerMonth-
GET/api/projectserver/v2/dashboard/topLanguagePairsReporting-Dienst /api/reports/Dashboard/TopLanguagePairs-
GET/api/projectserver/v2/dashboard/topLanguagePairs/{noOfTopLanguagePairs}Reporting-Dienst /api/reports/Dashboard/TopLanguagePairs-
GET/api/projectserver/v2/dashboard/wordsPerMonthReporting-Dienst /api/reports/Dashboard/WordsPerMonth-
GET/api/projectserver/v2/dashboard/wordsPerOrganizationReporting-Dienst /api/reports/Dashboard/WordsPerOrganization-
GET/api/projectserver/v2/projectPredefinedReportsReporting-Dienst /api/reports/Predefined/Projects-
POST/api/projectserver/v2/projects/{id}/api/projectserver/v2/projects-
DELETE/api/projectserver/v2/projects/{projectId}/changestatus/{status}/api/projectserver/v2/projects/{projectId}/detach[/{deleteProjectTMs}]-
PUT/api/projectserver/v2/projects/{projectId}/detach/api/projectserver/v2/projects/{projectId}/changestatus/{status}-
GET/api/projectserver/v2/tasksReportReporting-Dienst /api/reports/Predefined/Tasks-
GET/api/projectserver/v2/tmLeverageReportReporting-Dienst /api/reports/Predefined/TMLeverage-
DELETE/management/api/1.0/Membership/api/management/v2/roles/membership-
PUT/management/api/1.0/Membership/api/management/v2/roles/membership-
DELETE/management/api/1.0/Membership/{id}-Versehentliche Route
PUT/management/api/1.0/Membership/{id}-Versehentliche Route
DELETE/management/api/1.0/Membership/{name}-Versehentliche Route
PUT/management/api/1.0/Membership/{name}-Versehentliche Route
DELETE/management/api/1.0/Organizations/api/management/v2/organizations/{id}-
POST/management/api/1.0/Organizations/api/management/v2/organizations-
GET/management/api/1.0/Organizations/api/management/v2/organizations-
PUT/management/api/1.0/Organizations/api/management/v2/organizations-
DELETE/management/api/1.0/Organizations/{id}/api/management/v2/organizations/{id}-
GET/management/api/1.0/Organizations/{id}/api/management/v2/organizations/{id}-
POST/management/api/1.0/Organizations/{id}-Versehentliche Route
PUT/management/api/1.0/Organizations/{id}-Versehentliche Route
DELETE/management/api/1.0/Organizations/{name}-Versehentliche Route
PUT/management/api/1.0/Organizations/{name}-Versehentliche Route
GET/management/api/1.0/Organizations/{name}-Versehentliche Route
POST/management/api/1.0/Organizations/{name}-Versehentliche Route
GET/management/api/1.0/Permissions/api/management/v2/permissions-
GET/management/api/1.0/Permissions/{id}/api/management/v2/permissions-
GET/management/api/1.0/Permissions/{name}/api/management/v2/permissions-
DELETE/management/api/1.0/Roles/api/management/v2/roles/{id}-
GET/management/api/1.0/Roles/api/management/v2/roles-
POST/management/api/1.0/Roles/api/management/v2/roles-
PUT/management/api/1.0/Roles/api/management/v2/roles-
DELETE/management/api/1.0/Roles/{id}/api/management/v2/roles/{id}-
POST/management/api/1.0/Roles/{id}/api/management/v2/roles-
PUT/management/api/1.0/Roles/{id}/api/management/v2/roles-
GET/management/api/1.0/Roles/{id}/api/management/v2/roles/{id}-
DELETE/management/api/1.0/Roles/{name}/api/management/v2/roles/{id}-
GET/management/api/1.0/Roles/{name}/api/management/v2/roles-
POST/management/api/1.0/Roles/{name}/api/management/v2/roles-
PUT/management/api/1.0/Roles/{name}/api/management/v2/roles-
DELETE/management/api/1.0/roles/{roleId}/membership/api/management/v2/roles/membership-
PUT/management/api/1.0/roles/{roleId}/membership-Versehentliche Route
DELETE/management/api/1.0/roles/membership/api/management/v2/roles/membership-
PUT/management/api/1.0/roles/membership/api/management/v2/roles/membership-
DELETE/management/api/1.0/Users/api/management/v2/users/{id}-
GET/management/api/1.0/Users/api/management/v2/users-
POST/management/api/1.0/Users/api/management/v2/users-
PUT/management/api/1.0/Users/api/management/v2/users-
DELETE/management/api/1.0/Users/{id}/api/management/v2/users/{id}-
GET/management/api/1.0/Users/{id}/api/management/v2/users/{id}-
POST/management/api/1.0/Users/{id}/api/management/v2/users-
PUT/management/api/1.0/Users/{id}/api/management/v2/users-
DELETE/management/api/1.0/Users/{name}/api/management/v2/users/{id}-
GET/management/api/1.0/Users/{name}/api/management/v2/users/{id}-
POST/management/api/1.0/Users/{name}/api/management/v2/users-
PUT/management/api/1.0/Users/{name}/api/management/v2/users-
DELETE/multiterm/api/1.0/termbases/{termbaseId}/concepts-Versehentliche Route
GET/multiterm/api/1.0/termbases/{termbaseId}/concepts-Versehentliche Route
POST/multiterm/api/1.0/termbases/{termbaseId}/concepts/{conceptId}-Versehentliche Route
PUT/multiterm/api/1.0/termbases/{termbaseId}/concepts/{conceptId}-Versehentliche Route
GET/multiterm/api/1.0/termbases/{termbaseId}/multimedia-Versehentliche Route
POST/multiterm/api/1.0/termbases/{termbaseId}/multimedia/{imageId}-Versehentliche Route
POST/projectserver/api/1.0/CreateProject/api/projectserver/v2/projects/{projectId}/create-
GET/projectserver/api/1.0/FileDownload/api/projectserver/v2/projects/{projectId}/download-
GET/projectserver/api/1.0/FileStatus/api/projectserver/v2/projects/{projectId}/files-
GET/projectserver/api/1.0/phases/{projectId}/api/projectserver/v2/phases/{projectId}-
GET/projectserver/api/1.0/Projects/api/projectserver/v2/projects-
POST/projectserver/api/1.0/Projects/api/projectserver/v2/projects-
DELETE/projectserver/api/1.0/projects/{id}/api/projectserver/v2/projects/{id}-
GET/projectserver/api/1.0/projects/{id}/api/projectserver/v2/projects/{id}-
POST/projectserver/api/1.0/projects/{id}/api/projectserver/v2/projects-
DELETE/projectserver/api/1.0/projects/{id}/Delete/api/projectserver/v2/projects/{id}-
GET/projectserver/api/1.0/projects/{id}/Get/api/projectserver/v2/projects/{id}-
GET/projectserver/api/1.0/projects/{id}/GetByResourceGroupPath/api/projectserver/v2/projects/byresourcegroup-
POST/projectserver/api/1.0/projects/{id}/Post/api/projectserver/v2/projects-
POST/projectserver/api/1.0/projects/{projectId}/changeassignment/api/projectserver/v2/projects/{projectId}/changeassignment-
POST/projectserver/api/1.0/projects/{projectId}/changephase/api/projectserver/v2/projects/{projectId}/changephase-
GET/projectserver/api/1.0/projects/{projectId}/download/api/projectserver/v2/projects/{projectId}/download-
GET/projectserver/api/1.0/projects/{projectId}/download/{type}/api/projectserver/v2/projects/{projectId}/download/{type}-
GET/projectserver/api/1.0/projects/{projectId}/filestatus/api/projectserver/v2/projects/{projectId}/files-
GET/projectserver/api/1.0/projects/{projectId}/filestatus/languagefiles/api/projectserver/v2/projects/{projectId}/files-
GET/projectserver/api/1.0/projects/{projectId}/phaseswithassignees/{phaseId}/api/projectserver/v2/projects/{projectId}/phaseswithassignees/{phaseId}-
GET/projectserver/api/1.0/projects/{projectId}/publishingstatus/api/projectserver/v2/projects/{projectId}/publishingstatus-
POST/projectserver/api/1.0/projects/{projectId}/publishpackage/api/projectserver/v2/projects/{projectId}/publishpackage-
GET/projectserver/api/1.0/PublishingStatus/api/projectserver/v2/projects/{projectId}/publishingstatus-
POST/projectserver/api/1.0/PublishPackage/api/projectserver/v2/projects/{projectId}/publishpackage-