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
Request body structures
ConfigUnlockRequest

Data structures
Description of all the data structures used by the API
- Request body structures
  - AddFavoriteRequest
    This is the request body for the ynu1713990307383.html method.
  - ApprovalConfigurationRequest
  - AdvancedSearchRequest
  - AssignmentRequest
    This is the request body for the abf1729627022169.html method.
  - ChangeStatusRequest
  - ChangeTitleRequest
  - ChildExpansionParameterRequest
  - CloneDocumentRequest
  - CollaborativeReviewConfigurationRequest
  - ConfigLockRequest
  - ConfigUnlockRequest
  - CreateApprovalOrCollaborativeReviewRequest
  - CreateBranchRequest
  - CreateDocumentRequest
  - CreateManifestRequest
    This request body is part of the yow1729197908384.html method to create a translation manifest from a map.
  - CreateResourceDataRequest
  - CreateSnapshotRequest
  - GenerateOutputRequest
  - ImageSearchRequest
  - ImportImageRequest
  - InsertAsChildParameterRequest
  - InsertAtSameLevelParameterRequest
  - ManageFavoriteFolderRequest
  - ManageFavoriteRequest
  - ManageWorkListDocumentsRequest
  - ManageWorkListUsersRequest
  - MapSessionParameterRequest
  - MoveMapElementAsFirstChildParameterRequest
  - MoveMapElementAtSameLevelParameterRequest
  - NextResultsRequest
  - PrepareForEditRequest
  - PrepareKitRequest
    This request body is part of the wdg1713990260233.html method.
  - ReferencesRequest
    This request body is part of the mhx1713990256925.html method to include directives to the translation agency as part of the localization kit.
  - RenameWorklistRequest
  - ReplaceArgument
    Use this request data structure to run a replacement specific for the search and replace feature.
  - ResourceFileUpdateInformationRequest
  - RevertToRequest
  - SearchForReplaceArgument
    Use this request data structure to run a search specific for the search and replace feature.
  - SearchRequest
  - Snapshot
  - SortRequest
  - SpellCheckArgument
  - SpellCheckCorrection
  - SpellCheckIgnoreToken
  - TrackerLinkRequest
  - UpdateResultsRequest
- Response body structures
- Other structures
- Enumerations
  List of all the enumerated values used in the API.

ConfigUnlockRequest


Field	Type	Description
`documentIdentifier`	String	Full path of the configuration file to lock
`doBreakLock`	Boolean	Indicates whether to break the lock from another user

Generated by IXIA CCMS oXygen Webhelp