Web Services API compatibility across releases
Overview about which Web Service methods are available, supported or deprecated on a specific Content Manager version.
Support history for Web Services APIs
| Web Services API | Path | Description | Tridion Docs 15 | Tridion Docs 15.1 | Future releases |
|---|---|---|---|---|---|
| OpenAPI with OpenIdConnect | /ISHWS/Api/v3 | OpenAPI RESTful Web Services protected by modern OpenID Connect security protocol | Beta, working on parity with WCF SOAP Web Services (about 83 calls covered) | Supported, working on parity with WCF SOAP Web Services (about 126 calls covered) | Supported, working on parity with WCF SOAP Web Services (about 71 calls left to cover) |
| ASMX SOAP with AuthContext | /ISHWS/*.ASMX | SOAP 1.0 Web Services protected by proprietary security protocol | Deprecated, still works but no longer advised | Deprecated, still works but no longer advised | Obsolete, removed from product |
| WCF SOAP with WsTrust | /ISHWS/WCF/SVC | SOAP 1.1 Web Services protected by non-modern WS-Trust security protocol using WS-* security headers | Deprecated, still works but no longer advised | Deprecated, still works but no longer advised | Obsolete, removed from product |
| WCF SOAP with OpenIdConnect | /ISHWS/OWCF/SVC | SOAP 1.1 Web Services protected by modern OpenID Connect security protocol | Supported | Supported | Deprecated, still works but no longer advised |
Notation
The tables in this section use the following notation:
- S: is short for Supported which means that the method is fully supported.
- D: is short for Deprecated which means that there is a newer version of this method and you are strongly advised to not use this combination anymore because the method can be removed in one of the next versions.
- I: is short for Internal which means that the method is not available on web services and can still change in the next versions.
- -: means that the method was not yet available or has been removed since.
Annotations
| Method | 14.0.x / 14 | 15.x.0.0 / 15 |
|---|---|---|
| API25.Annotation.Create | S | S |
| API25.Annotation.CreateReply | S | S |
| API25.Annotation.Delete | S | S |
| API25.Annotation.DeleteReply | S | S |
| API25.Annotation.Find | S | S |
| API25.Annotation.RetrieveMetadata | S | S |
| API25.Annotation.Update | S | S |
| API25.Annotation.UpdateReply | S | S |
Application
| Method | 14.0.x / 14 | 15.x.0 / 15 | 15.1.x / 15.1 | Replaced by... |
|---|---|---|---|---|
| API.Application.GetVersion | S | S | D | API 3.0: GET /Application/Version |
| API20.Application.GetReleasedStates | S | S | S | |
| API20.Application.GetResource | S | S | S | |
| API20.Application.GetVersion | S | S | D | API 3.0: GET /Application/Version |
| API25.Application.Authenticate (ASMX only) | D | D | D | |
| API25.Application.Authenticate2 (WCF only) | I | I | I | |
| API25Application.GetApplicationName (ASMX only) | S | S | S | |
| API25Application.GetUserRef | I | I | I | |
| API25.Application.GetVersion | S | S | D | API 3.0: GET /Application/Version |
| API25.Application.Login (ASMX only) | S | S | S | |
| API 3.0: GET /Application/Version | - | - | S |
Background tasks
| Method | 14.0.x / 14 | 15.x.0 / 15 | 15.1.x / 15.1 | Replaced by... |
|---|---|---|---|---|
| API25.BackgroundTask.CreateBackgroundTask | S | S | S | |
| API25.BackgroundTask.CreateBackgroundTaskWithStartAfter | S | S | D | POST /v3/BackgroundTasks |
| API25.BackgroundTask.Find | S | S | S | |
| API25.BackgroundTask.RetrieveDataObjectByIshDataRefs | S | S | S | |
| POST /v3/BackgroundTasks | - | - | S |
Baselines
| Method | 14.0.x / 14 | 15.x.0 / 15 | 15.1.x / 15.1 | Replaced by... |
|---|---|---|---|---|
| API25.Baseline.CanBeFrozen | S | S | S | |
| API25.Baseline.CleanUp | S | S | S | |
| API25.Baseline.CompleteBaselineByCandidateAndMode | S | S | D | POST /v3/Baselines/{id}/Report/Complete |
| API25.Baseline.CompleteBaselineByMode | D | D | D | API25.Baseline.CompleteBaselineByCandidateAndMode |
| API25.Baseline.CompleteReportByCandidateAndMode | S | S | S | |
| API25.Baseline.CompleteReportByMode | D | D | D | API25.Baseline.CompleteReportByCandidateAndMode |
| API25.Baseline.Containing | S | S | S | |
| API25.Baseline.Copy | S | S | S | |
| API25.Baseline.Create | S | S | S | |
| API25.Baseline.Delete | S | S | S | |
| API25.Baseline.ExpandBaseline | S | S | D | POST /v3/Baselines/{id}/Report/Expand |
| API25.Baseline.ExpandReport | S | S | S | |
| API25.Baseline.ExtendReportByBaseline | S | S | S | |
| API25.Baseline.ExtendReportByCandidate | S | S | S | |
| API25.Baseline.Find | S | S | D | POST /v3/Baselines/Get |
| API25.Baseline.Freeze | S | S | S | |
| API25.Baseline.GetBaseline | S | S | S | |
| API25.Baseline.GetBaselineId | S | S | S | |
| API25.Baseline.GetBaselineName | S | S | S | |
| API25.Baseline.GetList | D | D | D | API25.Baseline.Find |
| API25.Baseline.GetMetadata | S | S | S | |
| API25.Baseline.GetReport | S | S | S | |
| API25.Baseline.Rename | - | - | D | API25.Baseline.Update |
| API25.Baseline.RetrieveMetadata | D | D | D | API25.Baseline.RetrieveMetadata2 |
| API25.Baseline.RetrieveMetadata2 | S | S | D | POST /v3/Baselines/Get |
| API25.Baseline.SetMetadata | S | S | S | |
| API25.Baseline.Update | S | S | S | |
| POST /v3/Baselines/Get | - | - | S | |
| POST /v3/Baselines/{id}/Report/Complete | - | - | S | |
| POST /v3/Baselines/{id}/Report/Expand | - | - | S |
Condition Management
| Method | 14.0.x / 14 | 15.x.0 / 15 | Replaced by... |
|---|---|---|---|
| API.ConditionManagement.CompareConditionCategories | S | - | |
| API.ConditionManagement.CompareConditionLists | S | - | |
| API.ConditionManagement.GetConditionCategories | S | - | |
| API.ConditionManagement.GetConditionMasterSet | S | - | |
| API.ConditionManagement.GetConditionSynchronisation | S | - | |
| API.ConditionManagement.UpdateConditionCategories | S | - | |
| API.ConditionManagement.UpdateConditionMasterSet | S | - |
Document objects
| Method | 14.0.x / 14 | 15.x.0 / 15 | 15.1.x / 15.1 | Replaced by... |
|---|---|---|---|---|
| API20.DocumentObj.AddShortCut | - | - | - | API25.Folder.AddShortCuts |
| API20.DocumentObj.CheckIn | - | - | - | API25.DocumentObj.CheckIn |
| API20.DocumentObj.CheckOut | - | - | - | API25.DocumentObj.CheckOut |
| API20.DocumentObj.Create | - | - | - | API25.DocumentObj.Create |
| API20.DocumentObj.CreateOrUpdate | - | - | - | API25.DocumentObj.TryGetMetadata followed by create or update |
| API20.DocumentObj.Delete | - | - | - | DELETE /v3/DocumentObjects/ByLogicalId/{logicalId} |
| API20.DocumentObj.GetInitialStates | - | - | - | API25.Settings.GetPossibleTargetStatuses |
| API20.DocumentObj.GetPossibleTransitionStates | - | - | - | API25.DocumentObj.GetPossibleTargetStatuses |
| API20.DocumentObj.Move | - | - | - | API25.Folder.MoveObjects |
| API20.DocumentObj.RemoveShortCut | - | - | - | API25.Folder.RemoveShortCuts |
| API20.DocumentObj.RetrieveObjects | - | - | - | API25.DocumentObj.RetrieveObjects |
| API20.DocumentObj.RetrievebyIshLngRef | - | - | - | API25.DocumentObj.RetrieveObjectsByIshLngRefs |
| API20.DocumentObj.SetMetaData | - | - | - | PUT /v3/DocumentObjects/ByLogicalId/{logicalId} |
| API20.DocumentObj.UndoCheckOut | - | - | - | API25.DocumentObj.UndoCheckOut |
| API20.DocumentObj.Update | - | - | - | PUT /v3/DocumentObjects/ByLogicalId/{logicalId} |
| API25.DocumentObj.CheckIn | S | S | S | |
| API25.DocumentObj.CheckInByIshLngRef | S | S | D | POST /v3/DocumentObjects/ByLanguageCardId/{languageCardId:long}/Content/CheckIn |
| API25.DocumentObj.CheckOut | S | S | S | |
| API25.DocumentObj.CheckOutByIshLngRef | S | S | D | POST /v3/DocumentObjects/ByLanguageCardId/{languageCardId:long}/Content/CheckOut |
| API25.DocumentObj.ContainingCondition | S | S | S | |
| API25.DocumentObj.ContainingLogicalId | S | S | D | POST /v3/DocumentObjects/ByLogicalId/{logicalId}/UsedInDocumentObjects/Get |
| API25.DocumentObj.ContainingVariable | S | S | S | |
| API25.DocumentObj.Create | S | S | S | |
| API25.DocumentObj.Delete | S | S | D | DELETE /v3/DocumentObjects/ByLogicalId/{logicalId} |
| API25.DocumentObj.DeleteByIshLngRef | S | S | D | DELETE /v3/DocumentObjects/ByLanguageCardId/{languageCardId:long} |
| API25.DocumentObj.Find | S | S | D | POST /v3/DocumentObjects/Get |
| API25.DocumentObj.FolderLocation | S | S | D | GET /v3/DocumentObjects/ByLogicalId/{logicalId}/Location |
| API25.DocumentObj.FolderLocations | S | S | S | |
| API25.DocumentObj.GetChildren | S | S | D | GET /v3/DocumentObjects/ByLanguageCardId/{languageCardId:long}/References |
| API25.DocumentObj.GetDataObjectInfoByIshLngRef | S | S | S | |
| API25.DocumentObj.GetMetadata | S | S | D | GET /v3/DocumentObjects/ByLogicalId/{logicalId}?Version={version}&Language={language}&Resolution={resolution} |
| API25.DocumentObj.GetMetadataByIshLngRef | S | S | D | GET /v3/DocumentObjects/ByLanguageCardId/{languageCardId:long} |
| API25.DocumentObj.GetObject | S | S | S | |
| API25.DocumentObj.GetParents | - | - | D | API25.DocumentObj.ContainingLogicalId |
| API25.DocumentObj.GetPossibleTargetStatuses | S | S | S | |
| API25.DocumentObj.GetPossibleTargetStatusesByIshLngRef | S | S | D | GET /v3/DocumentObjects/ByLanguageCardId/{languageCardId:long}/PossibleTargetStatuses |
| API25.DocumentObj.RaiseEventByIshLngRefs | S | S | D | POST /v3/DocumentObjects/ByLanguageCardId/BackgroundTasks/ |
| API25.DocumentObj.RaisePublishEvent | I | I | I | |
| API25.DocumentObj.RetrieveDataObjectInfoByIshLngRefs | S | S | S | |
| API25.DocumentObj.RetrieveLanguageMetadata | S | S | S | |
| API25.DocumentObj.RetrieveMetadata | S | S | D | POST /v3/DocumentObjects/ByLogicalId/Get |
| API25.DocumentObj.RetrieveMetadataByIshLngRefs | S | S | S | |
| API25.DocumentObj.RetrieveMetadataByIshLngRefs2 | S | S | D | POST /v3/DocumentObjects/ByLanguageCardId/Get |
| API25.DocumentObj.RetrieveMetadataByIshVersionRefs | S | S | S | |
| API25.DocumentObj.RetrieveObjects | S | S | S | |
| API25.DocumentObj.RetrieveObjectsByIshLngRefs | S | S | S | |
| API25.DocumentObj.RetrieveObjectsByRevisionIds | S | S | S | |
| API25.DocumentObj.RetrieveRevisionInfoByIshLngRefs | I | I | I | GET /v0/DocumentObjects/ByLanguageCardId/{cardId:long}/RevisionHistory |
| API25.DocumentObj.RetrieveVersionMetadata | S | S | S | |
| API25.DocumentObj.SetMetadata | S | S | D | PUT /v3/DocumentObjects/ByLogicalId/{logicalId} |
| API25.DocumentObj.SetMetadataByIshLngRef | S | S | D | PUT /v3/DocumentObjects/ByLanguageCardId/{languageCardId:long} |
| API25.DocumentObj.SetMetadataByIshLngRefs | S | S | S | |
| API25.DocumentObj.SmartTagByIshLngRef | S | S | D | POST /v3/DocumentObjects/ByLanguageCardId/{languageCardId:long}/SmartTags/Get |
| API25.DocumentObj.TryGetMetadata | S | S | S | |
| API25.DocumentObj.UndoCheckOut | S | S | S | |
| API25.DocumentObj.UndoCheckOutByIshLngRef | S | S | D | POST /v3/DocumentObjects/ByLanguageCardId/{languageCardId:long}/Content/UndoCheckout |
| API25.DocumentObj.Update | S | S | D | PUT /v3/DocumentObjects/ByLogicalId/{logicalId} |
| API25.DocumentObj.UpdateByIshLngRef | S | S | D | PUT /v3/DocumentObjects/ByLanguageCardId/{languageCardId:long}/Content |
| POST /v3/DocumentObjects/ByLogicalId/Get | - | - | S | |
| POST /v3/DocumentObjects/Get | - | - | S | |
| POST /v3/DocumentObjects/ByLanguageCardId/Get | - | - | S | |
| GET /v3/DocumentObjects/ByLogicalId/{logicalId} | - | - | S | |
| PUT /v3/DocumentObjects/ByLogicalId/{logicalId} | - | - | S | |
| DELETE /v3/DocumentObjects/ByLogicalId/{logicalId} | - | - | S | |
| GET /v3/DocumentObjects/ByLanguageCardId/{languageCardId:long} | - | - | S | |
| PUT /v3/DocumentObjects/ByLanguageCardId/{languageCardId:long} | - | - | S | |
| DELETE /v3/DocumentObjects/ByLanguageCardId/{languageCardId:long} | - | - | S | |
| GET /v3/DocumentObjects/ByLanguageCardId/{languageCardId:long}/Content | - | - | S | |
| PUT /v3/DocumentObjects/ByLanguageCardId/{languageCardId:long}/Content | - | - | S | |
| GET /v3/DocumentObjects/ByLanguageCardId/{languageCardId:long}/PossibleTargetStatuses | - | - | S | |
| GET /v3/DocumentObjects/PossibleTargetStatuses | - | - | S | |
| POST /v3/DocumentObjects/ByLanguageCardId/{languageCardId:long}/Content/CheckOut | - | - | S | |
| POST /v3/DocumentObjects/ByLanguageCardId/{languageCardId:long}/Content/CheckIn | - | - | S | |
| POST /v3/DocumentObjects/ByLanguageCardId/{languageCardId:long}/Content/UndoCheckout | - | - | S | |
| GET /v3/DocumentObjects/ByLogicalId/{logicalId}/Location | - | - | S | |
| POST /v3/DocumentObjects/ByLogicalId/{logicalId}/ByVersion/{Version}/UsedInPublications/Get | - | - | S | |
| POST /v3/DocumentObjects/ByLogicalId/{logicalId}/UsedInDocumentObjects/Get | - | - | S | |
| GET /v3/DocumentObjects/ByLanguageCardId/{languageCardId:long}/References | - | - | S | |
| POST /v3/DocumentObjects/ByLanguageCardId/{languageCardId:long}/SmartTags/Get | - | - | S | |
| POST /v3/DocumentObjects/ByLanguageCardId/BackgroundTasks/ | - | - | S | |
| PUT /v3/DocumentObjects/ByLogicalId/{logicalId} | - | - | S |
EDT
| Method | 14.0.x / 14 | 15.x.0 / 15 | 15.1.x / 15.1 | Replaced by... |
|---|---|---|---|---|
| API25.EDT.Create | S | S | S | |
| API25.EDT.Delete | S | S | S | |
| API25.EDT.Find | S | S | S | |
| API25.EDT.GetList | D | D | D | API25.EDT.Find |
| API25.EDT.GetMetadata | S | S | S | |
| API25.EDT.RetrieveMetadata | S | S | S | |
| API25.EDT.Update | S | S | S |
Event Monitor
| Method | 14.0.x / 14 | 15.x.0 / 15 | 15.1.x / 15.1 | Replaced by... |
|---|---|---|---|---|
| API25.EventMonitor.AddEventDetail | S | S | D | POST /v3/Events/Details |
| API25.EventMonitor.AddEventDetailWithProgress | S | S | D | POST /v3/Events/Details |
| API25.EventMonitor.DeleteByProgressId | S | S | D | DELETE /v3/Events/ByProgressId/{progressId:long} |
| API25.EventMonitor.EndEvent | S | S | D | POST /v3/Events/ByProgressId/{progressId:long}/Terminate |
| API25.EventMonitor.GetEventDetail | S | S | D | GET /v3/Events/ByDetailId/{detailId:long} |
| API25.EventMonitor.GetNextEventDetailDataChunk | S | S | D | GET /v3/Events/ByDetailId/{detailId:long}/Content |
| API25.EventMonitor.GetProgressId | S | S | D | GET /v3/Events/ByEventId/{eventId} |
| API25.EventMonitor.RetrieveEventOverview | S | S | D | POST /v3/Events/Overview/Get |
| API25.EventMonitor.RetrieveEventOverviewByProgressIds | I | I | I | POST v3/Events/ByProgressId/Overview/Get |
| API25.EventMonitor.RetrieveEventsByParentProgressIds | S | S | D | POST /v3/Events/ByParentProgressId/Get |
| API25.EventMonitor.RetrieveEventsByProgressIds | S | S | D | POST /v3/Events/ByProgressId/Get |
| API25.EventMonitor.StartEvent | S | S | D | POST /v3/Events |
| POST /v3/Events | - | - | S | |
| DELETE /v3/Events/ByProgressId/{progressId:long} | - | - | S | |
| POST /v3/Events/ByProgressId/{progressId:long}/Terminate | - | - | S | |
| POST /v3/Events/ByProgressId/Get | - | - | S | |
| POST /v3/Events/ByParentProgressId/Get | - | - | S | |
| POST /v3/Events/Details | - | - | S | |
| POST /v3/Events/Overview/Get | - | - | S | |
| POST v3/Events/ByProgressId/Overview/Get | - | - | S | |
| GET /v3/Events/ByDetailId/{detailId:long} | - | - | S | |
| GET /v3/Events/ByEventId/{eventId} | - | - | S | |
| GET /v3/Events/ByDetailId/{detailId:long}/Content | - | - | S |
Folders
| Method | 14.0.x / 14 | 15.x.0 / 15 | 15.1.x / 15.1 | Replaced by... |
|---|---|---|---|---|
| API25.Folder.AddShortCuts | S | S | D | PUT /v3/Folders/{id}/Shortcuts |
| API25.Folder.Create | S | S | D | POST /v3/Folders/ |
| API25.Folder.CreateQueryFolder | S | S | D | None (query folders are deprecated) |
| API25.Folder.CreateReferenceFolder | S | S | D | POST /v3/Folders/ |
| API25.Folder.Delete | S | S | D | DELETE /v3/Folders/{id} |
| API25.Folder. Exists | I | I | I | |
| API25.Folder.FolderLocation | S | S | D | GET /v3/Folders/{id}/Location |
| API25.Folder.GetContents | S | S | D | GET /v3/Folders/{id}/Objects |
| API25.Folder.GetMetadata | S | S | D | GET /v3/Folders/ByFolderPath |
| API25.Folder.GetMetadataByIshFolderRef | S | S | D | GET /v3/Folders/{id} |
| API25.Folder.GetSubFolders | S | S | D | GET /v3/Folders/ByFolderPath followed by GET /v3/Folders/{id}/Objects |
| API25.Folder.GetSubFoldersByIshFolderRef | S | S | D | GET /v3/Folders/{id}/Objects |
| API25.Folder.Move | S | S | D | POST /v3/Folders/MoveFolder |
| API25.Folder.MoveObjects | S | S | D | POST /v3/Folders/MoveObject |
| API25.Folder.RemoveShortCuts | S | S | D | DELETE /v3/Folders/{id}/Shortcuts |
| API25.Folder.Rename | S | S | D | Rename function is deprecated. Use PUT /v3/Folders/{id} to update instead. |
| API25.Folder.RetrieveMetadataByIshFolderRefs | S | S | D | POST /v3/Folders/Get |
| API25.Folder.Update | S | S | D | PUT /v3/Folders/{id} |
| API25.Folder.UpdateQueryFolder | S | S | D | None (query folders are deprecated) |
| API25.Folder.UpdateReferenceFolder | S | S | D | PUT /v3/Folders/{id} |
| GET /v3/Folders/RootFolders | - | - | S | |
| GET /v3/Folders/{id}/Objects | - | - | S | |
| DELETE /v3/Folders/{id} | - | - | S | |
| GET /v3/Folders/{id} | - | - | S | |
| PUT /v3/Folders/{id} | - | - | S | |
| POST /v3/Folders/ | - | - | S | |
| POST /v3/Folders/Get | - | - | S | |
| POST /v3/Folders/MoveFolder | - | - | S | |
| POST /v3/Folders/MoveObject | - | - | S | |
| DELETE /v3/Folders/{id}/Shortcuts | - | - | S | |
| PUT /v3/Folders/{id}/Shortcuts | - | - | S | |
| GET /v3/Folders/{id}/Location | - | - | S | |
| GET /v3/Folders/ByFolderPath | - | - | S |
Inboxes
| Method | 14.0.x / 14 | 15.x.0 / 15 | 15.1.x / 15.1 |
|---|---|---|---|
| POST /v3/Inboxes/{id}/Objects/Get | - | - | S |
| GET /v3/Inboxes | - | - | S |
List of Values
| Method | 14.0.x / 14 | 15.x.0 / 15 | 15.1.x / 15.1 | Replaced by... |
|---|---|---|---|---|
| API25.ListOfValues.CreateValue | D | D | D | POST /v3/Lists/{id}/Values |
| API25.ListOfValues.CreateValue2 | S | S | D | POST /v3/Lists/{id}/Values |
| API25.ListOfValues.DeleteValue | S | S | D | DELETE /v3/Lists/{id}/Values/{valueId} |
| API25.ListOfValues.RetrieveLists | S | S | D | POST /v3/Lists/Get |
| API25.ListOfValues.RetrieveValues | S | S | D | GET /v3/Lists/{id}/Values |
| API25.ListOfValues.UpdateValue | S | S | D | PUT /v3/Lists/{id}/Values/{valueId} |
| GET /v3/Lists/{id}/Values | - | - | S | |
| POST /v3/Lists/{id}/Values | - | - | S | |
| PUT /v3/Lists/{id}/Values/{valueId} | - | - | S | |
| DELETE /v3/Lists/{id}/Values/{valueId} | - | - | S | |
| GET /v3/Lists/{id}/Values/{valueId} | - | - | S | |
| POST /v3/Lists/Get | - | - | S |
Metadata binding
| Method | 14.0.x / 14 | 15.x.0 / 15 | 15.1.x / 15.1 | Replaced by... |
|---|---|---|---|---|
| API25.MetadataBinding.ResolveIds | S | S | S | |
| API25.MetadataBinding.RetrieveTags | S | S | D | POST /v3/MetadataBinding/Fields/{fieldName}/Levels/{fieldLevel}/Tags/Get |
| API25.MetadataBinding.RetrieveTagStructure | S | S | D | POST /v3/MetadataBinding/Fields/{fieldName}/Levels/{fieldLevel}/TagStructure/Get |
| API25.MetadataBinding.SmartTag | S | S | D | POST /v3/MetadataBinding/SmartTags/Get |
| API25.MetadataBinding.Validate | I | I | I | |
| POST /v3/MetadataBinding/Fields/{fieldName}/Levels/{fieldLevel}/Tags/Get | - | - | S | |
| POST /v3/MetadataBinding/Fields/{fieldName}/Levels/{fieldLevel}/TagStructure/Get | - | - | S | |
| POST /v3/MetadataBinding/SmartTags/Get | - | - | S |
My
| Method | 14.0.x / 14 | 15.x.0 / 15 | 15.1.x / 15.1 |
|---|---|---|---|
| GET /v3/My | - | - | S |
| PUT /v3/My | - | - | S |
| GET /v3/My/PreferenceSets/{SetName} | - | - | S |
| PUT /v3/My/PreferenceSets/{SetName} | - | - | S |
| DELETE /v3/My/PreferenceSets/{SetName} | - | - | S |
| GET /v3/My/Privileges | - | - | S |
Objects
| Method | 14.0.x / 14 | 15.x.0 / 15 | 15.1.x / 15.1 |
|---|---|---|---|
| GET /v3/Objects/{id} | - | - | S |
Output formats
| Method | 14.0.x / 14 | 15.x.0 / 15 | 15.1.x / 15.1 | Replaced by... |
|---|---|---|---|---|
| API25.OutputFormat.Create | S | S | D | POST /v3/OutputFormats |
| API25.OutputFormat.Delete | S | S | D | DELETE /v3/OutputFormats/{id} |
| API25.OutputFormat.Find | S | S | D | POST /v3/OutputFormats/Get |
| API25.OutputFormat.GetMetadata | S | S | D | GET /v3/OutputFormats/{id} |
| API25.OutputFormat.GetOutputFormatId | S | S | S | |
| API25.OutputFormat.GetOutputFormatName | S | S | S | |
| API25.OutputFormat.RetrieveMetadata | S | S | D | POST /v3/OutputFormats/Get |
| API25.OutputFormat.Update | S | S | D | PUT /v3/OutputFormats/{id} |
| GET /v3/OutputFormats/{id} | - | - | S | |
| PUT /v3/OutputFormats/{id} | - | - | S | |
| DELETE /v3/OutputFormats/{id} | - | - | S | |
| POST /v3/OutputFormats | - | - | S | |
| POST /v3/OutputFormats/Get | - | - | S |
Projects
| Method | 14.0.x / 14 | 15.x.0 / 15 | 15.1.x / 15.1 |
|---|---|---|---|
| POST /v3/Projects | - | - | S |
| POST /v3/Projects/Get | - | - | S |
| POST /v3/Projects/ByProjectId/Get | - | - | S |
| PUT /v3/Projects/ByProjectId/{projectId} | - | - | S |
| DELETE /v3/Projects/ByProjectId/{projectId} | - | - | S |
| POST /v3/Projects/Assignees | - | - | S |
| PUT /v3/Projects/ByAssigneeCardId/{assigneeCardId} | - | - | S |
| DELETE /v3/Projects/ByAssigneeCardId/{assigneeCardId} | - | - | S |
Publications
| Method | 14.0.x / 14 | 15.x.0 / 15 | 15.1.x / 15.1 | Replaced by... |
|---|---|---|---|---|
| API20.Publication.Create | - | - | - | API25.PublicationOutput.Create |
| API20.Publication.Copy | - | - | - | API25.Baseline.Copy followed by API25.PublicationOutput.Create with the newly created baseline. |
| API20.Publication.Delete | - | - | - | DELETE /v3/Publications/ByLogicalId/{logicalId}?version={version} |
| API20.Publication.SetMetaData | - | - | - | PUT /v3/Publications/ByLogicalId/{logicalId} |
| API20.PublicationOutput.CancelPublish | - | - | - | API25.PublicationOutput.SetMetadata with VPUBSTATUSPUBLISHINGCANCELLED |
| API20.PublicationOutput.CancelPublishByIshLngRef | - | - | - | API25.PublicationOutput.SetMetadataByIshLngRef with VPUBSTATUSPUBLISHINGCANCELLED |
| API20.PublicationOutput.Create | - | - | - | API25.PublicationOutput.Create |
| API20.PublicationOutput.Delete | - | - | - | DELETE /v3/Publications/ByLogicalId/{logicalId}?version={version} |
| API20.PublicationOutput.DeleteByIshLngRef | - | - | - | DELETE /v3/Publications/ByLanguageCardId/{languageCardId} |
| API20.PublicationOutput.GetReport | D | D | D | API25.PublicationOutput.GetMetaData followed by API25.PublicationOutput.PublishReportInfoByIshLngRef and API25.PublicationOutput.GetNextPublishReportChunkByIshLngRef. |
| API20.PublicationOutput.GetReportByIshLngRef | D | D | D | API25.PublicationOutput.PublishReportInfoByIshLngRef followed by API25.PublicationOutput.GetNextPublishReportChunkByIshLngRef. |
| API20.PublicationOutput.Publish | - | - | - | API25.PublicationOutput.SetMetadata with VPUBSTATUSPUBLISHPENDING |
| API20.PublicationOutput.PublishByIshLngRef | - | - | - | API25.PublicationOutput.SetMetadataByIshLngRef with VPUBSTATUSPUBLISHPENDING |
| API20.PublicationOutput.SetMetadata | - | - | - | PUT /v3/Publications/ByLogicalId/{logicalId} |
| API20.PublicationOutput.SetMetaDataByIshLngRef | - | - | - | PUT /v3/Publications/ByLanguageCardId/{languageCardId} |
| API25.PublicationOutput.Containing | S | S | D | POST /v3/DocumentObjects/ByLogicalId/{logicalId}/ByVersion/{versionnumber}/UsedInPublications/Get |
| API25.PublicationOutput.Create | S | S | S | |
| API25.PublicationOutput.Delete | S | S | D | DELETE /v3/Publications/ByLogicalId/{logicalId}?version={version} |
| API25.PublicationOutput.DeleteByIshLngRef | S | S | D | DELETE /v3/Publications/ByLanguageCardId/{languageCardId} |
| API25.PublicationOutput.Find | S | S | D | POST /v3/Publications/Get |
| API25.PublicationOutput.FolderLocation | S | S | D | GET /v3/Publications/ByLogicalId/{logicalId}/Location |
| API25.PublicationOutput.FolderLocations | S | S | S | |
| API25.PublicationOutput.GetDataObjectInfoByIshLngRef | I | I | I | |
| API25.PublicationOutput.GetMetadata | S | S | D | GET /v3/Publications/ByLogicalId/{logicalId} |
| API25.PublicationOutput.GetMetadataByIshLngRef | S | S | D | GET /v3/Publications/ByLanguageCardId/{languageCardId} |
| API25.PublicationOutput.GetNextDataObjectChunkByIshLngRef | S | S | S | |
| API25.PublicationOutput.GetNextPublishLogObjectChunkByIshLngRef | S | S | S | |
| API25.PublicationOutput.GetNextPublishReportChunkByIshLngRef | S | S | S | |
| API25.PublicationOutput.GetPossibleTargetStatuses | I | I | I | |
| API25.PublicationOutput.GetPossibleTargetStatusesByIshLngRef | I | I | I | |
| API25.PublicationOutput.GetPublishLogObjectInfoByIshLngRef | S | S | S | |
| API25.PublicationOutput.GetPublishReportInfoByIshLngRef | S | S | S | |
| API25.PublicationOutput.Release | - | - | - | API25.Baseline.Freeze followed by a API25.PublicationOutput.SetMetadata VPUBSTATUSRELEASED |
| API25.PublicationOutput.ReleaseByIshLngRef | - | - | - | API25.Baseline.Freeze followed by a API25.PublicationOutput.SetMetadata VPUBSTATUSRELEASED |
| API25.PublicationOutput.RetrieveMetadata | S | S | D | POST /v3/Publications/ByLogicalId/Get |
| API25.PublicationOutput.RetrieveMetadataByIshLngRefs | S | S | D | POST /v3/Publications/ByLanguageCardId/Get |
| API25.PublicationOutput.RetrieveMetadataByIshVersionRefs | S | S | S | |
| API25.PublicationOutput.RetrieveVersionMetadata | S | S | S | |
| API25.PublicationOutput.SetMetadata | S | S | D | PUT /v3/Publications/ByLogicalId/{logicalId} |
| API25.PublicationOutput.SetMetadataByIshLngRef | S | S | D | PUT /v3/Publications/ByLanguageCardId/{languageCardId} |
| API25.PublicationOutput.SetMetadataByIshLngRefs | S | S | S | |
| API25.PublicationOutput.SetDataObjectByIshLngRef | I | I | I | |
| API25.PublicationOutput.SetPublishReportByIshLngRef | I | I | I | |
| API25.PublicationOutput.TryGetMetadata | S | S | S | |
| API25.PublicationOutput.UsingBaseline | S | S | S | |
| PUT /v3/Publications/ByLanguageCardId/{languageCardId} | - | - | S | |
| DELETE /v3/Publications/ByLanguageCardId/{languageCardId} | - | - | S | |
| GET /v3/Publications/ByLanguageCardId/{languageCardId} | - | - | S | |
| PUT /v3/Publications/ByLogicalId/{logicalId} | - | - | S | |
| DELETE /v3/Publications/ByLogicalId/{logicalId} | - | - | S | |
| GET /v3/Publications/ByLogicalId/{logicalId} | - | - | S | |
| POST /v3/Publications/ByLanguageCardId/{languageCardId}/Release | - | - | S | |
| POST /v3/Publications/ByLanguageCardId/{languageCardId}/Unrelease | - | - | S | |
| POST /v3/Publications/ByLogicalId/Get | - | - | S | |
| POST /v3/Publications/Get | - | - | S | |
| POST /v3/Publications/ByLanguageCardId/Get | - | - | S | |
| GET /v3/Publications/ByLanguageCardId/{languageCardId}/Content | - | - | S | |
| GET /v3/Publications/ByLogicalId/{logicalId}/Location | - | - | S | |
| POST /v3/Publications/ByLanguageCardId/{languageCardId}/CancelPublish | - | - | S | |
| POST /v3/Publications/ByLanguageCardId/{languageCardId}/Publish | - | - | S | |
| POST /v3/Publications/ByLanguageCardId/{languageCardId}/Unpublish | - | - | S |
Reports
| Method | 14.0.x / 14 | 15.x.0 / 15 | 15.1.x / 15.1 | Replaced by... |
|---|---|---|---|---|
| API20.Reports.GetReferencedDocObj | D | - | - | |
| API20.Reports.GetReferencesByIshLngRef | D | - | - | GET /v3/DocumentObjects/ByLanguageCardId/{languageCardId:long}/References |
Search
| Method | 14.0.x / 14 | 15.0.x / 15 | 15.1.x / 15.1 | Replaced by... |
|---|---|---|---|---|
| API25.Search.PerformSearch | S | S | D | POST /v3/Search |
| API25.Search.PerformSearchInPublication | S | S | S | |
| POST /v3/Search | - | - | S |
Settings
| Method | 14.0.x / 14 | 15.x.0 / 15 | 15.1.x / 15.1 | Replaced by... |
|---|---|---|---|---|
| API25.Settings.GetMetadata | S | S | D | GET /v3/Settings |
| API25.Settings.GetPossibleTargetStatuses | S | S | S | |
| API25.Settings.GetTimeZone | S | S | S | |
| API25.Settings.GetTranslationStatuses | S | S | D | GET /v3/Settings/TranslationStatuses |
| API25.Settings.RetrieveFieldSetupByIshType | S | S | D | GET /v3/Settings/FieldDefinitions |
| API25.Settings.SetMetaData3 | S | S | D | PUT /v3/Settings |
| GET /v3/Settings | - | - | S | |
| PUT /v3/Settings | - | - | S | |
| GET /v3/Settings/WorkflowReport | - | - | S | |
| GET /v3/Settings/TranslationReport | - | - | S | |
| GET /v3/Settings/FieldDefinitions | - | - | S | |
| GET /v3/Settings/TranslationStatuses | - | - | S |
Translation
| Method | 14.0.x / 14 | 15.x.0 / 15 | 15.1.x / 15.1 |
|---|---|---|---|
| API25.TranslationJob.CreateExternalTranslationJobs | S | S | S |
| API25.TranslationJob.CreateTranslationJob | S | S | S |
| API25.TranslationJob.CreateTranslationJobItems | S | S | S |
| API25.TranslationJob.Delete | S | S | S |
| API25.TranslationJob.DeleteExternalTranslationJobs | S | S | S |
| API25.TranslationJob.DeleteTranslationJobItems | S | S | S |
| API25.TranslationJob.Find | S | S | S |
| API25.TranslationJob.GetMetadata | S | S | S |
| API25.TranslationJob.GetPossibleTargetStatuses | S | S | S |
| API25.TranslationJob.GetTranslationJob | S | S | S |
| API25.TranslationJob.RetrieveExternalTranslationJobs | S | S | S |
| API25.TranslationJob.RetrieveMetadata | S | S | S |
| API25.TranslationJob.RetrieveTranslationJobItems | S | S | S |
| API25.TranslationJob.SetMetadata3 | S | S | S |
| API25.TranslationJob.UpdateTranslationJob3 | S | S | S |
| API25.TranslationJob.UpdateTranslationJobItems | S | S | S |
| API25.TranslationManagement.CreateTranslationFromVersion | I | - | - |
| API25.TranslationTemplate.Create | S | S | S |
| API25.TranslationTemplate.Delete | S | S | S |
| API25.TranslationTemplate.DeleteByTypeAndAlias | S | S | S |
| API25.TranslationTemplate.Retrieve | S | S | S |
Users
| Method | 14.0.x / 14 | 15.x.0 / 15 | 15.1.x / 15.1 | Replace by: |
|---|---|---|---|---|
| API25.User.ChangePassword | S | S | S | |
| API25.User.Create | S | S | D | POST /v3/Users |
| API25.User.Delete | S | S | D | DELETE /v3/Users/{id} |
| API25.User.Find | S | S | D | POST /v3/Users/Get |
| API25.User.GetMetadata | S | S | D | GET /v3/Users/{id} |
| API25.User.GetMetadataByIshUserRef | S | S | S | |
| API25.User.GetMyMetadata | S | S | D | GET /v3/My |
| API25.User.IsInRole | I | I | I | |
| API25.User.RetrieveMetadata | S | S | D | POST /v3/Users/Get |
| API25.User.RetrieveMetadataByIshUserRefs | S | S | S | |
| API25.User.Update | S | S | D | PUT /v3/Users/{id} |
| API25.User.DeletePreference | S | S | D | DELETE /v3/Users/{id}/PreferenceSets/{setName}?itemName={itemName} |
| API25.User.FindPreferences | S | S | S | |
| API25.User.RetrievePreferences | S | S | D | GET /v3/Users/{id}/PreferenceSets/{setName} |
| API25.User.SetPreferences | S | S | D | PUT /v3/Users/{id}/PreferenceSets/{setName} |
| POST /v3/Users/Get | - | - | S | |
| GET /v3/Users/{id} | - | - | S | |
| PUT /v3/Users/{id} | - | - | S | |
| DELETE /v3/Users/{id} | - | - | S | |
| POST /v3/Users | - | - | S | |
| GET /v3/Users/{id}/PreferenceSets/{setName} | - | - | S | |
| PUT /v3/Users/{id}/PreferenceSets/{setName} | - | - | S | |
| DELETE /v3/Users/{id}/PreferenceSets/{setName} | - | - | S |
User Groups
| Method | 14.0.x / 14 | 15.x.0 / 15 | 15.1.x / 15.1 | Replace by: |
|---|---|---|---|---|
| API25.UserGroup.Create | S | S | D | POST /v3/UserGroups |
| API25.UserGroup.Delete | S | S | D | DELETE /v3/UserGroups/{id} |
| API25.UserGroup.Find | S | S | D | POST /v3/UserGroups/Get |
| API25.UserGroup.GetMetadata | S | S | D | GET /v3/UserGroups/{id} |
| API25.UserGroup.RetrieveMetadata | S | S | D | POST /v3/UserGroups/Get |
| API25.UserGroup.Update | S | S | D | PUT /v3/UserGroups/{id} |
| GET /v3/UserGroups/{id} | - | - | S | |
| PUT /v3/UserGroups/{id} | - | - | S | |
| DELETE /v3/UserGroups/{id} | - | - | S | |
| POST /v3/UserGroups/Get | - | - | S | |
| POST /v3/UserGroups | - | - | S |
User Roles
| Method | 14.0.x / 14 | 15.x.0 / 15 | 15.1.x / 15.1 | Replace by: |
|---|---|---|---|---|
| API25.UserRole.Create | S | S | S | POST /v3/UserRoles |
| API25.UserRole.Delete | S | S | S | DELETE /v3/UserRoles/{id} |
| API25.UserRole.Find | S | S | S | POST /v3/UserRoles/Get |
| API25.UserRole.GetMetadata | S | S | S | GET /v3/UserRoles/{id} |
| API25.UserRole.RetrieveMetadata | S | S | S | POST /v3/UserRoles/Get |
| API25.UserRole.Update | S | S | S | PUT /v3/UserRoles/{id} |
| GET /v3/UserRoles/{id} | - | - | S | |
| PUT /v3/UserRoles/{id} | - | - | S | |
| DELETE /v3/UserRoles/{id} | - | - | S | |
| POST /v3/UserRoles/Get | - | - | S | |
| POST /v3/UserRoles | - | - | S |
Workflow
| Method | 14.0.x / 14 | 15.x.0 / 15 | 15.x.1 / 15.1 | Replaced by... |
|---|---|---|---|---|
| API20.WorkFlow.GetInboxContent | S | S | D | POST /v3/Inboxes/{id}/Objects/Get |
| API20.WorkFlow.GetInboxes | S | S | D | GET /v3/Inboxes |
| GET /v3/Workflows/StatusDefinitions | - | - | S | |
| POST /v3/Workflows/StatusDefinitions | - | - | S | |
| GET /v3/Workflows/StatusDefinitions/{id} | - | - | S | |
| PUT /v3/Workflows/StatusDefinitions/{id} | - | - | S | |
| DELETE /v3/Workflows/StatusDefinitions/{id} | - | - | S |