Modifications apportées à l'API pour les développeurs tiers

Avec cette version, nous introduisons la documentation de l'API basée sur OpenAPI. Elle est disponible au format OpenAPI JSON lisible par ordinateur, et peut être utilisée pour l'automatisation de la découverte des points de terminaison.

Vous pouvez rechercher la documentation disponible pour l'intégralité de RestAPI à l'adresse suivante : http(s)://<gserver>/docs/<section>, où <gsserver> est le serveur hôte et <section> peut-être :

  • pris en charge : contient tous les points de terminaison pris en charge. Il s'agit du document recommandé pour une utilisation régulière.
  • tout : contient tous les points de terminaison, y compris les obsolètes.
  • V4 : contient uniquement les points de terminaison appartenant à la version 4.
  • V3 : contient uniquement les points de terminaison appartenant à la version 3.
  • V2 : contient uniquement les points de terminaison appartenant à la version 2.
  • V1 : contient uniquement les points de terminaison appartenant à la version 1. Ces points de terminaison sont obsolètes pour le serveur de projets et la gestion.
Vous pouvez rechercher des API spécifiques aux liens suivants :
  • http(s)://<gserver>/docs/projectserver/<section>
  • http(s)://<gserver>/docs/management/<section>
  • http(s)://<gserver>/docs/multiterm/<section>
  • http(s)://<gserver>/docs/authentication/<section>

Dans les liens ci-dessus :

  • <gserver> est le serveur hôte
  • <section> peut correspondre à tout (contient tous les points de terminaison disponibles), ou pris en charge (contient uniquement les points de terminaison non obsolètes).

Points de terminaison obsolètes

Nous avons marqué les points de terminaison de l'interface de programmation d'application REST suivants comme obsolètes et nous prévoyons de les supprimer dans les prochaines versions :

HttpMethodRoutes obsolètesAlternativeRaison
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/projectsPerMonthService de création de rapports /api/reports/Dashboard/ProjectsPerMonth-
GET/api/projectserver/v2/dashboard/topLanguagePairsService de création de rapports /api/reports/Dashboard/TopLanguagePairs-
GET/api/projectserver/v2/dashboard/topLanguagePairs/{noOfTopLanguagePairs}Service de création de rapports /api/reports/Dashboard/TopLanguagePairs-
GET/api/projectserver/v2/dashboard/wordsPerMonthService de création de rapports /api/reports/Dashboard/WordsPerMonth-
GET/api/projectserver/v2/dashboard/wordsPerOrganizationService de création de rapports /api/reports/Dashboard/WordsPerOrganization-
GET/api/projectserver/v2/projectPredefinedReportsService de création de rapports /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/tasksReportService de création de rapports /api/reports/Predefined/Tasks-
GET/api/projectserver/v2/tmLeverageReportService de création de rapports /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}-Route accidentelle
PUT/management/api/1.0/Membership/{id}-Route accidentelle
DELETE/management/api/1.0/Membership/{name}-Route accidentelle
PUT/management/api/1.0/Membership/{name}-Route accidentelle
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}-Route accidentelle
PUT/management/api/1.0/Organizations/{id}-Route accidentelle
DELETE/management/api/1.0/Organizations/{name}-Route accidentelle
PUT/management/api/1.0/Organizations/{name}-Route accidentelle
GET/management/api/1.0/Organizations/{name}-Route accidentelle
POST/management/api/1.0/Organizations/{name}-Route accidentelle
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-Route accidentelle
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-Route accidentelle
GET/multiterm/api/1.0/termbases/{termbaseId}/concepts-Route accidentelle
POST/multiterm/api/1.0/termbases/{termbaseId}/concepts/{conceptId}-Route accidentelle
PUT/multiterm/api/1.0/termbases/{termbaseId}/concepts/{conceptId}-Route accidentelle
GET/multiterm/api/1.0/termbases/{termbaseId}/multimedia-Route accidentelle
POST/multiterm/api/1.0/termbases/{termbaseId}/multimedia/{imageId}-Route accidentelle
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-