Jump to main content

IXIA CCMS REST API Documentation

Important information
Changes between 7.4 and 7.5
Methods
Data structures

Home
Data structures
Description of all the data structures used by the API
Response body structures
DeleteResult
Use this response data structure when receiving a request to delete a document.

Data structures
Description of all the data structures used by the API
- Request body structures
- Response body structures
  - AddFavouriteResult
    This is the response body for the ynu1713990307383.html method.
  - AddFavouritesFolderResult
  - AssignmentResult
    This is the response body for the abf1729627022169.html method.
  - ApprovalOrCollaborativeReviewConfigurationResult
  - ApprovalOrCollaborativeReviewOutputsResult
  - CheckInResult
  - ColumnDefinitionResult
  - ConfigLockInfoResult
  - CreateApprovalOrCollaborativeReviewResult
  - CreateDitaObjectResult
  - CreateDocumentResult
  - CreateTranslationManifestResult
    This response body is part of the yow1729197908384.html method to create a translation manifest from a map.
  - CreateNewInstanceResult
  - CreateSnapshotResult
  - CreateWorklistResult
  - DeleteResult
    Use this response data structure when receiving a request to delete a document.
  - DependenciesResult
    This response body is part of the ddw1713990256784.html method to return all language manifests related to a specific translation manifest of a map and mhx1713990256925.html method to include directives to the translation agency as part of the localization kit.
  - DocumentsInformationResult
  - DocumentIdentifierResult
  - EntryResult
    This result body is part of the cul1713990304560.html.
  - ExternalTypesResult
  - GenerateOutputResult
  - GetAnnotationsResult
  - FavouritesInformationResult
    This results body is part of cul1713990304560.html.
  - FolderResult
    This result body is part of the cul1713990304560.html.
  - GetWorklistsResult
  - ImageSearchResult
  - InitialStatusAndRolesResult
  - InstancesResult
  - LanguagesResult
    This request body is part of pcw1713990252708.html.
  - ListRolesResult
  - ListTemplatesResult
  - LocalizationKitResult
    This is the response body for the method used during the initial preparation and import of the localization kit.
  - ManageFavoriteObjectResult
  - ManageWorkListDocumentsResult
  - ManageWorkListUsersResult
  - MapSessionResult
  - OutputTypesResult
  - PrepareForEditResult
    This response body is part of the vwc1729610884823.html method to prepare a document in translation for an edition.
  - ReloadConfigResult
  - RenameFolderResult
  - RenameWorklistResult
  - RevisionHistoryResult
  - SearchParametersResult
  - SearchResult
  - SearchForReplaceResult
    Receive these response data structures after a request for a search used with the search and replace feature.
  - SearchResultsUpdateResult
  - SnapshotInformationResult
  - SpellCheckIgnoreToken
  - SpellCheckResult
  - SpellCheckResultInfo
  - StatusesAndRolesResult
  - StatusInformationResult
  - SubjectSchemeResult
  - SystemInformationResult
  - TaxonomyTermsResult
  - TranslationManifestResult
    This response body is part of the method used to obtain information on a translation manifest.
  - UserOutputsResult
- Other structures
- Enumerations
  List of all the enumerated values used in the API.

DeleteResult

Use this response data structure when receiving a request to delete a document.


Field	Type	Description
`path`	String	The deleted document path

Generated by IXIA CCMS oXygen Webhelp