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
Other structures
CustomIndexCaption

Data structures
Description of all the data structures used by the API
- Request body structures
- Response body structures
- Other structures
  - Annotation
  - AnnotationRange
  - AnnotationStatus
  - AnnotationUser
  - AssignmentRequest
    This is the request body for the abf1729627022169.html method.
  - AssignmentInformation
  - BranchDetails
  - BranchInformation
  - BranchMapping
  - BuildManifestInformation
  - CompareInformation
  - CustomIndex
  - CustomIndexCaption
  - DateTime
  - DependencyCategory
  - DitavalInformation
  - DitavalProp
  - DocumentCorrection
    Use this data structure to specify a correction or replacement.
  - DocumentInformation
  - DocumentType
    Provides the list of specialized types (concept, task, etc.) for a generic type (map, topic, image)
  - DrmObject
  - Feature
  - HeaderDefinition
  - InputType
  - InitialStatusRule
    Common data structure used as part of the pcw1713990252708.html.
  - KeyDefinitionItem
  - Language
  - MapElementParameter
  - MapNodeItem
  - Option
  - OutputInformation
  - OutputMessage
  - OutputType
  - ParentsInformation
  - PossibleStatuses
  - PreProcessor
  - ReferableContentInformation
  - ResourceFileInformation
  - ResourceInformation
  - RevisionInformation
  - RoleInformation
  - SearchCriteria
  - SearchResultItem
  - SessionInformation
  - Snapshot
  - SnapshotRefItem
  - Status
  - StatusNameTypeAndLevel
  - StructureDefinition
  - SubjectDefinition
  - SubQuery
  - SystemParameter
  - TemplateDefinition
  - Tokens
  - TranslationManifest
    Common data structure used as part of the pcw1713990252708.html.
  - TranslationManifestRefItem
    Common data structure used as part of the pcw1713990252708.html.
  - UserAssignment
  - UserEmail
  - UserIdentifier
  - UserInformation
  - UserName
  - UserParameter
  - UserParameterValue
  - UserProfile
  - UserProperty
- Enumerations
  List of all the enumerated values used in the API.

CustomIndexCaption


Field	Type	Description
`caption`	String	Label for the custom index
`language`	String	Language code for the label

Generated by IXIA CCMS oXygen Webhelp