Technical Details

catalog

Message Types and Data Types

Service Operations (Technical Names)

This process component provides the following service operations:

You use this information when preparing the implementation phase of your project. During the developments, use the WSDL provided by a running SAP CC Core Server system at the appropriate endpoint over HTTP. Use the technical name of this process component (catalog) to determine the relevant endpoint URL.

Note

Consult the functional specification of each service operation for more information about the business context and use, the error handling, and the prerequisites.

Legend
  • The XML elements are ordered and required by default. Each element is described on a line by its:
    • Name
    • Type (or base type)
    • Use: Optional (*), required (default), prohibited
    • Default value
    • Occurrence: Unique (default), multiple
    • Nillable attribute
    • Restricted enumeration
  • The attributes are prefixed using the @ character. Each attribute is described on a line by its:
    • Name
    • Type (or base type)
    • Use: Optional (*) (default), required, prohibited
    • Default value
    • Restricted enumeration

Important Note (*)

This SAP product documentation is based on the XML Schema handled by SAP CC. It does not show the conditional elements or attributes at business level. However conditional constraints may exist on certain elements or attributes that are tagged as optional. Refer to the annotations or comments that precise the final business use.

Message Types

This section details all the message types defined by this process component (Web service). Consult the specifications of both the request and response that correspond to your service operation.

Operation: chargePlanClassFind

The following message types are specified for the chargePlanClassFind operation:

Message Type: chargePlanClassFindRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The chargePlanClassFindRequest message type is structured as follows:

  • chargePlanClassSearchFilter (ChargePlanClassSearchFilter)
    • searchWindow (SearchFilterWindow, optional)
      The settings to enable reference-based pagination of search results in response. Several operation requests are necessary to retrieve the complete results.
      • windowSize (int, optional)
        The maximum number of results expected in the operation response. The SAP CC system returns a subset of the matching result set.
      • fromUniqueId (String256, optional)
        The reference to start pagination from. When omitted in the first search operation request, the beginning of the result set is returned by the SAP CC system. When set in an operation request, it must be equal to the lastUniqueId element in the previous operation response.
    • totalCountRequired (boolean, optional, default: "false")
    • id (StringAttributeDescription, optional)

    • description (StringAttributeDescription, optional)

    • status (Status, optional, {open | released | obsolete})
    • additionalInfo ... (AdditionalAttributeDescription, optional, multiple)
      • name (String256)

        • pattern (String256)
        • stringEnumeration (StringEnumeration)
        • numberEnumeration (NumberEnumeration)
        • dateEnumeration (DateEnumeration)
          • value ... (Date, multiple)
        • numberRange (NumberRange)
          • min (NumberBoundary)
            • @included (boolean, default: "true")
          • max (NumberBoundary)
            • @included (boolean, default: "true")
        • dateRange (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")

Message Type: chargePlanClassFindResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The chargePlanClassFindResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • totalCount (int, optional)
    The number of remaining objects in the set after the current page found by the SAP CC system. This includes the number of objects in the current set.
  • lastUniqueId (String256, optional)
    The reference of the last element in case of pagination. Set up the fromUniqueId element in the next search operation request with this reference value.
  • chargePlanClass ... (ChargePlanClass, optional, multiple)
    • id (String256)
    • owner (String256)
    • status (Status, optional, {open | released | obsolete})
    • description (String2000, optional)
    • additionalInfo ... (AdditionalInfo, optional, multiple)
    • parameter ... (Parameter, optional, multiple)
    • counter ... (Counter, optional, multiple)
    • accountAssignment ... (TypedAccountAssignment, optional, multiple)
    • userTechnicalIdentifier ... (ChargePlanClassUserTechnicalIdentifier, optional, multiple)
      • name (String256)
      • description (String2000, optional)
      • serviceTechnicalIdentifier ... (ServiceTechnicalIdentifier, multiple)

Operation: chargePlanClassDescriptionFind

The following message types are specified for the chargePlanClassDescriptionFind operation:

Message Type: chargePlanClassDescriptionFindRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The chargePlanClassDescriptionFindRequest message type is structured as follows:

  • chargePlanClassSearchFilter (ChargePlanClassSearchFilter)
    • searchWindow (SearchFilterWindow, optional)
      The settings to enable reference-based pagination of search results in response. Several operation requests are necessary to retrieve the complete results.
      • windowSize (int, optional)
        The maximum number of results expected in the operation response. The SAP CC system returns a subset of the matching result set.
      • fromUniqueId (String256, optional)
        The reference to start pagination from. When omitted in the first search operation request, the beginning of the result set is returned by the SAP CC system. When set in an operation request, it must be equal to the lastUniqueId element in the previous operation response.
    • totalCountRequired (boolean, optional, default: "false")
    • id (StringAttributeDescription, optional)

    • description (StringAttributeDescription, optional)

    • status (Status, optional, {open | released | obsolete})
    • additionalInfo ... (AdditionalAttributeDescription, optional, multiple)
      • name (String256)

        • pattern (String256)
        • stringEnumeration (StringEnumeration)
        • numberEnumeration (NumberEnumeration)
        • dateEnumeration (DateEnumeration)
          • value ... (Date, multiple)
        • numberRange (NumberRange)
          • min (NumberBoundary)
            • @included (boolean, default: "true")
          • max (NumberBoundary)
            • @included (boolean, default: "true")
        • dateRange (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")

Message Type: chargePlanClassDescriptionFindResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The chargePlanClassDescriptionFindResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • totalCount (int, optional)
    The number of remaining objects in the set after the current page found by the SAP CC system. This includes the number of objects in the current set.
  • lastUniqueId (String256, optional)
    The reference of the last element in case of pagination. Set up the fromUniqueId element in the next search operation request with this reference value.
  • chargePlanClassDescription ... (Description, optional, multiple)

Operation: refillPlanClassFind

The following message types are specified for the refillPlanClassFind operation:

Message Type: refillPlanClassFindRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The refillPlanClassFindRequest message type is structured as follows:

  • refillPlanClassSearchFilter (RefillPlanClassSearchFilter)
    • searchWindow (SearchFilterWindow, optional)
      The settings to enable reference-based pagination of search results in response. Several operation requests are necessary to retrieve the complete results.
      • windowSize (int, optional)
        The maximum number of results expected in the operation response. The SAP CC system returns a subset of the matching result set.
      • fromUniqueId (String256, optional)
        The reference to start pagination from. When omitted in the first search operation request, the beginning of the result set is returned by the SAP CC system. When set in an operation request, it must be equal to the lastUniqueId element in the previous operation response.
    • totalCountRequired (boolean, optional, default: "false")
    • id (StringAttributeDescription, optional)

    • description (StringAttributeDescription, optional)

    • status (Status, optional, {open | released | obsolete})
    • additionalInfo ... (AdditionalAttributeDescription, optional, multiple)
      • name (String256)

        • pattern (String256)
        • stringEnumeration (StringEnumeration)
        • numberEnumeration (NumberEnumeration)
        • dateEnumeration (DateEnumeration)
          • value ... (Date, multiple)
        • numberRange (NumberRange)
          • min (NumberBoundary)
            • @included (boolean, default: "true")
          • max (NumberBoundary)
            • @included (boolean, default: "true")
        • dateRange (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")

Message Type: refillPlanClassFindResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The refillPlanClassFindResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • totalCount (int, optional)
    The number of remaining objects in the set after the current page found by the SAP CC system. This includes the number of objects in the current set.
  • lastUniqueId (String256, optional)
    The reference of the last element in case of pagination. Set up the fromUniqueId element in the next search operation request with this reference value.
  • refillPlanClass ... (RefillPlanClass, optional, multiple)

Operation: refillPlanClassDescriptionFind

The following message types are specified for the refillPlanClassDescriptionFind operation:

Message Type: refillPlanClassDescriptionFindRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The refillPlanClassDescriptionFindRequest message type is structured as follows:

  • refillPlanClassSearchFilter (RefillPlanClassSearchFilter)
    • searchWindow (SearchFilterWindow, optional)
      The settings to enable reference-based pagination of search results in response. Several operation requests are necessary to retrieve the complete results.
      • windowSize (int, optional)
        The maximum number of results expected in the operation response. The SAP CC system returns a subset of the matching result set.
      • fromUniqueId (String256, optional)
        The reference to start pagination from. When omitted in the first search operation request, the beginning of the result set is returned by the SAP CC system. When set in an operation request, it must be equal to the lastUniqueId element in the previous operation response.
    • totalCountRequired (boolean, optional, default: "false")
    • id (StringAttributeDescription, optional)

    • description (StringAttributeDescription, optional)

    • status (Status, optional, {open | released | obsolete})
    • additionalInfo ... (AdditionalAttributeDescription, optional, multiple)
      • name (String256)

        • pattern (String256)
        • stringEnumeration (StringEnumeration)
        • numberEnumeration (NumberEnumeration)
        • dateEnumeration (DateEnumeration)
          • value ... (Date, multiple)
        • numberRange (NumberRange)
          • min (NumberBoundary)
            • @included (boolean, default: "true")
          • max (NumberBoundary)
            • @included (boolean, default: "true")
        • dateRange (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")

Message Type: refillPlanClassDescriptionFindResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The refillPlanClassDescriptionFindResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • totalCount (int, optional)
    The number of remaining objects in the set after the current page found by the SAP CC system. This includes the number of objects in the current set.
  • lastUniqueId (String256, optional)
    The reference of the last element in case of pagination. Set up the fromUniqueId element in the next search operation request with this reference value.
  • refillPlanClassDescription ... (Description, optional, multiple)

Operation: mappingTableClassFind

The following message types are specified for the mappingTableClassFind operation:

Message Type: mappingTableClassFindRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The mappingTableClassFindRequest message type is structured as follows:

  • mappingTableClassSearchFilter (MappingTableClassSearchFilter)
    • searchWindow (SearchFilterWindow, optional)
      The settings to enable reference-based pagination of search results in response. Several operation requests are necessary to retrieve the complete results.
      • windowSize (int, optional)
        The maximum number of results expected in the operation response. The SAP CC system returns a subset of the matching result set.
      • fromUniqueId (String256, optional)
        The reference to start pagination from. When omitted in the first search operation request, the beginning of the result set is returned by the SAP CC system. When set in an operation request, it must be equal to the lastUniqueId element in the previous operation response.
    • totalCountRequired (boolean, optional, default: "false")
    • id (StringAttributeDescription, optional)

    • description (StringAttributeDescription, optional)

    • additionalInfo ... (AdditionalAttributeDescription, optional, multiple)
      • name (String256)

        • pattern (String256)
        • stringEnumeration (StringEnumeration)
        • numberEnumeration (NumberEnumeration)
        • dateEnumeration (DateEnumeration)
          • value ... (Date, multiple)
        • numberRange (NumberRange)
          • min (NumberBoundary)
            • @included (boolean, default: "true")
          • max (NumberBoundary)
            • @included (boolean, default: "true")
        • dateRange (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")

Message Type: mappingTableClassFindResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The mappingTableClassFindResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • totalCount (int, optional)
    The number of remaining objects in the set after the current page found by the SAP CC system. This includes the number of objects in the current set.
  • lastUniqueId (String256, optional)
    The reference of the last element in case of pagination. Set up the fromUniqueId element in the next search operation request with this reference value.
  • mappingTableClass ... (MappingTableClass, optional, multiple)

Operation: mappingTableCreate

The following message types are specified for the mappingTableCreate operation:

Message Type: mappingTableCreateRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The mappingTableCreateRequest message type is structured as follows:

Message Type: mappingTableCreateResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The mappingTableCreateResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • id (String256, optional)
  • reference (String256, optional)

Operation: mappingTableMaintain

The following message types are specified for the mappingTableMaintain operation:

Message Type: mappingTableMaintainRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The mappingTableMaintainRequest message type is structured as follows:

Message Type: mappingTableMaintainResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The mappingTableMaintainResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • id (String256, optional)
  • reference (String256, optional)

Operation: mappingTableCancel

The following message types are specified for the mappingTableCancel operation:

Message Type: mappingTableCancelRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The mappingTableCancelRequest message type is structured as follows:

Message Type: mappingTableCancelResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The mappingTableCancelResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • id (String256, optional)
  • reference (String256, optional)

Operation: mappingTableFind

The following message types are specified for the mappingTableFind operation:

Message Type: mappingTableFindRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The mappingTableFindRequest message type is structured as follows:

  • mappingTableSearchFilter (MappingTableSearchFilter)
    • searchWindow (SearchFilterWindow, optional)
      The settings to enable reference-based pagination of search results in response. Several operation requests are necessary to retrieve the complete results.
      • windowSize (int, optional)
        The maximum number of results expected in the operation response. The SAP CC system returns a subset of the matching result set.
      • fromUniqueId (String256, optional)
        The reference to start pagination from. When omitted in the first search operation request, the beginning of the result set is returned by the SAP CC system. When set in an operation request, it must be equal to the lastUniqueId element in the previous operation response.
    • totalCountRequired (boolean, optional, default: "false")
    • id (StringAttributeDescription, optional)

    • mappingTableClassId (StringAttributeDescription, optional)

    • additionalInfo ... (AdditionalAttributeDescription, optional, multiple)
      • name (String256)

        • pattern (String256)
        • stringEnumeration (StringEnumeration)
        • numberEnumeration (NumberEnumeration)
        • dateEnumeration (DateEnumeration)
          • value ... (Date, multiple)
        • numberRange (NumberRange)
          • min (NumberBoundary)
            • @included (boolean, default: "true")
          • max (NumberBoundary)
            • @included (boolean, default: "true")
        • dateRange (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")
    • omitRows (boolean, optional, default: "false")
      Set this flag to true when you want the table's rows to be omitted from the response.

Message Type: mappingTableFindResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The mappingTableFindResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • totalCount (int, optional)
    The number of remaining objects in the set after the current page found by the SAP CC system. This includes the number of objects in the current set.
  • lastUniqueId (String256, optional)
    The reference of the last element in case of pagination. Set up the fromUniqueId element in the next search operation request with this reference value.
  • mappingTable ... (MappingTable, optional, multiple)

Operation: mappingTableRowMaintain

The following message types are specified for the mappingTableRowMaintain operation:

Message Type: mappingTableRowMaintainRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The mappingTableRowMaintainRequest message type is structured as follows:

Message Type: mappingTableRowMaintainResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The mappingTableRowMaintainResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • mappingTableId (String256, optional)
  • reference (String256, optional)

Operation: mappingTableRowCancel

The following message types are specified for the mappingTableRowCancel operation:

Message Type: mappingTableRowCancelRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The mappingTableRowCancelRequest message type is structured as follows:

Message Type: mappingTableRowCancelResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The mappingTableRowCancelResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • mappingTableId (String256, optional)
  • reference (String256, optional)

Operation: mappingTableRowMaintainBundle

The following message types are specified for the mappingTableRowMaintainBundle operation:

Message Type: mappingTableRowMaintainBundleRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The mappingTableRowMaintainBundleRequest message type is structured as follows:

  • mappingTableRowMaintainRequest ... (mappingTableRowMaintainRequest, multiple (max: 1000))

Message Type: mappingTableRowMaintainBundleResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The mappingTableRowMaintainBundleResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • mappingTableRowMaintainResponse ... (mappingTableRowMaintainResponse, optional, multiple (max: 1000))

Operation: mappingTableRowCancelBundle

The following message types are specified for the mappingTableRowCancelBundle operation:

Message Type: mappingTableRowCancelBundleRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The mappingTableRowCancelBundleRequest message type is structured as follows:

  • mappingTableRowCancelRequest ... (mappingTableRowCancelRequest, multiple (max: 1000))

Message Type: mappingTableRowCancelBundleResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The mappingTableRowCancelBundleResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • mappingTableRowCancelResponse ... (mappingTableRowCancelResponse, optional, multiple (max: 1000))

Operation: rangeTableClassFind

The following message types are specified for the rangeTableClassFind operation:

Message Type: rangeTableClassFindRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The rangeTableClassFindRequest message type is structured as follows:

  • rangeTableClassSearchFilter (RangeTableClassSearchFilter)
    • searchWindow (SearchFilterWindow, optional)
      The settings to enable reference-based pagination of search results in response. Several operation requests are necessary to retrieve the complete results.
      • windowSize (int, optional)
        The maximum number of results expected in the operation response. The SAP CC system returns a subset of the matching result set.
      • fromUniqueId (String256, optional)
        The reference to start pagination from. When omitted in the first search operation request, the beginning of the result set is returned by the SAP CC system. When set in an operation request, it must be equal to the lastUniqueId element in the previous operation response.
    • totalCountRequired (boolean, optional, default: "false")
    • id (StringAttributeDescription, optional)

    • description (StringAttributeDescription, optional)

    • additionalInfo ... (AdditionalAttributeDescription, optional, multiple)
      • name (String256)

        • pattern (String256)
        • stringEnumeration (StringEnumeration)
        • numberEnumeration (NumberEnumeration)
        • dateEnumeration (DateEnumeration)
          • value ... (Date, multiple)
        • numberRange (NumberRange)
          • min (NumberBoundary)
            • @included (boolean, default: "true")
          • max (NumberBoundary)
            • @included (boolean, default: "true")
        • dateRange (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")

Message Type: rangeTableClassFindResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The rangeTableClassFindResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • totalCount (int, optional)
    The number of remaining objects in the set after the current page found by the SAP CC system. This includes the number of objects in the current set.
  • lastUniqueId (String256, optional)
    The reference of the last element in case of pagination. Set up the fromUniqueId element in the next search operation request with this reference value.
  • rangeTableClass ... (RangeTableClass, optional, multiple)
    • id (String256)
    • description (String2000, optional)
    • rangeUpperBound (RangeBound, {exclusive | inclusive})
    • lastRange (LastRange, {bounded | unbounded})
    • outputColumn ... (RangeTableClassOutputColumn, multiple (max: 15))
      • name (String256)
      • description (String2000, optional)

        • string (String256, nillable)
        • number (RangeTableClassDecimalOutputColumn, nillable)
          • @computationMode (ComputationMode, default: "single", {single | cumulative | rangeSizeCumulative})
    • additionalInfo ... (AdditionalInfo, optional, multiple)

Operation: rangeTableMaintain

The following message types are specified for the rangeTableMaintain operation:

Message Type: rangeTableMaintainRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The rangeTableMaintainRequest message type is structured as follows:

Message Type: rangeTableMaintainResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The rangeTableMaintainResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • id (String256, optional)
  • reference (String256, optional)

Operation: rangeTableCancel

The following message types are specified for the rangeTableCancel operation:

Message Type: rangeTableCancelRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The rangeTableCancelRequest message type is structured as follows:

Message Type: rangeTableCancelResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The rangeTableCancelResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • id (String256, optional)
  • reference (String256, optional)

Operation: rangeTableFind

The following message types are specified for the rangeTableFind operation:

Message Type: rangeTableFindRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The rangeTableFindRequest message type is structured as follows:

  • rangeTableSearchFilter (RangeTableSearchFilter)
    • searchWindow (SearchFilterWindow, optional)
      The settings to enable reference-based pagination of search results in response. Several operation requests are necessary to retrieve the complete results.
      • windowSize (int, optional)
        The maximum number of results expected in the operation response. The SAP CC system returns a subset of the matching result set.
      • fromUniqueId (String256, optional)
        The reference to start pagination from. When omitted in the first search operation request, the beginning of the result set is returned by the SAP CC system. When set in an operation request, it must be equal to the lastUniqueId element in the previous operation response.
    • totalCountRequired (boolean, optional, default: "false")
    • id (StringAttributeDescription, optional)

    • description (StringAttributeDescription, optional)

    • rangeTableClassId (StringAttributeDescription, optional)

    • additionalInfo ... (AdditionalAttributeDescription, optional, multiple)
      • name (String256)

        • pattern (String256)
        • stringEnumeration (StringEnumeration)
        • numberEnumeration (NumberEnumeration)
        • dateEnumeration (DateEnumeration)
          • value ... (Date, multiple)
        • numberRange (NumberRange)
          • min (NumberBoundary)
            • @included (boolean, default: "true")
          • max (NumberBoundary)
            • @included (boolean, default: "true")
        • dateRange (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")

Message Type: rangeTableFindResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The rangeTableFindResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • totalCount (int, optional)
    The number of remaining objects in the set after the current page found by the SAP CC system. This includes the number of objects in the current set.
  • lastUniqueId (String256, optional)
    The reference of the last element in case of pagination. Set up the fromUniqueId element in the next search operation request with this reference value.
  • rangeTable ... (RangeTable, optional, multiple)
    • id (String256)
    • description (String2000, optional)
    • rangeTableClassId (String256)
    • additionalInfo ... (AdditionalInfo, optional, multiple)
    • revisions ... (RangeTableRevision, multiple)
      • validityStartDate (Date, optional)
      • validityEndDate (Date, optional)
      • row ... (RangeTableRow, multiple)

        • column ... (RangeTableColumn, multiple (max: 15))

Operation: monitoringPlanClassFind

The following message types are specified for the monitoringPlanClassFind operation:

Message Type: monitoringPlanClassFindRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The monitoringPlanClassFindRequest message type is structured as follows:

  • monitoringPlanClassSearchFilter (MonitoringPlanClassSearchFilter)
    • searchWindow (SearchFilterWindow, optional)
      The settings to enable reference-based pagination of search results in response. Several operation requests are necessary to retrieve the complete results.
      • windowSize (int, optional)
        The maximum number of results expected in the operation response. The SAP CC system returns a subset of the matching result set.
      • fromUniqueId (String256, optional)
        The reference to start pagination from. When omitted in the first search operation request, the beginning of the result set is returned by the SAP CC system. When set in an operation request, it must be equal to the lastUniqueId element in the previous operation response.
    • totalCountRequired (boolean, optional, default: "false")
    • id (StringAttributeDescription, optional)

    • description (StringAttributeDescription, optional)

    • status (Status, optional, {open | released | obsolete})
    • additionalInfo ... (AdditionalAttributeDescription, optional, multiple)
      • name (String256)

        • pattern (String256)
        • stringEnumeration (StringEnumeration)
        • numberEnumeration (NumberEnumeration)
        • dateEnumeration (DateEnumeration)
          • value ... (Date, multiple)
        • numberRange (NumberRange)
          • min (NumberBoundary)
            • @included (boolean, default: "true")
          • max (NumberBoundary)
            • @included (boolean, default: "true")
        • dateRange (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")

Message Type: monitoringPlanClassFindResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The monitoringPlanClassFindResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • totalCount (int, optional)
    The number of remaining objects in the set after the current page found by the SAP CC system. This includes the number of objects in the current set.
  • lastUniqueId (String256, optional)
    The reference of the last element in case of pagination. Set up the fromUniqueId element in the next search operation request with this reference value.
  • monitoringPlanClass ... (MonitoringPlanClass, optional, multiple)
    • id (String256)
    • owner (String256)
    • status (Status, optional, {open | released | obsolete})
    • description (String2000, optional)
    • additionalInfo ... (AdditionalInfo, optional, multiple)
    • counter ... (Counter, optional, multiple)
    • spendingStatusDescription ... (SpendingStatusDescription, optional, multiple)
    • userTechnicalIdentifier ... (UserTechnicalIdentifier, optional, multiple)

Operation: monitoringPlanClassDescriptionFind

The following message types are specified for the monitoringPlanClassDescriptionFind operation:

Message Type: monitoringPlanClassDescriptionFindRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The monitoringPlanClassDescriptionFindRequest message type is structured as follows:

  • monitoringPlanClassSearchFilter (MonitoringPlanClassSearchFilter)
    • searchWindow (SearchFilterWindow, optional)
      The settings to enable reference-based pagination of search results in response. Several operation requests are necessary to retrieve the complete results.
      • windowSize (int, optional)
        The maximum number of results expected in the operation response. The SAP CC system returns a subset of the matching result set.
      • fromUniqueId (String256, optional)
        The reference to start pagination from. When omitted in the first search operation request, the beginning of the result set is returned by the SAP CC system. When set in an operation request, it must be equal to the lastUniqueId element in the previous operation response.
    • totalCountRequired (boolean, optional, default: "false")
    • id (StringAttributeDescription, optional)

    • description (StringAttributeDescription, optional)

    • status (Status, optional, {open | released | obsolete})
    • additionalInfo ... (AdditionalAttributeDescription, optional, multiple)
      • name (String256)

        • pattern (String256)
        • stringEnumeration (StringEnumeration)
        • numberEnumeration (NumberEnumeration)
        • dateEnumeration (DateEnumeration)
          • value ... (Date, multiple)
        • numberRange (NumberRange)
          • min (NumberBoundary)
            • @included (boolean, default: "true")
          • max (NumberBoundary)
            • @included (boolean, default: "true")
        • dateRange (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")

Message Type: monitoringPlanClassDescriptionFindResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The monitoringPlanClassDescriptionFindResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • totalCount (int, optional)
    The number of remaining objects in the set after the current page found by the SAP CC system. This includes the number of objects in the current set.
  • lastUniqueId (String256, optional)
    The reference of the last element in case of pagination. Set up the fromUniqueId element in the next search operation request with this reference value.
  • monitoringPlanClassDescription ... (Description, optional, multiple)

Simple Types

The message types use the following simple types:

ResponseStatus

Syntax

This is a restriction of the String256 type.

The possible values are:

  • return
  • error
  • inProgress
FailureCategory

Syntax

This is a restriction of the String256 type.

The possible values are:

  • alreadyExists
  • doesNotExist
  • invalid
  • prerequisiteMissing
  • incompatibleConfiguration
  • illegalState
  • temporaryIllegalState
SearchOrderType

Syntax

This is a restriction of the String256 type.

The possible values are:

  • asc
  • desc
  • noOrder
SearchFilterType

Syntax

This is a restriction of the string type.

The possible values are:

  • boolean
  • number
  • string
  • date
Decimal28_6

Syntax

This is a restriction of the decimal type.

  • maxInclusive: 9999999999999999999999.999999
  • minInclusive: -9999999999999999999999.999999
  • totalDigits: 28
  • fractionDigits: 6
Long

Syntax

This is a restriction of the long type.

  • maxInclusive: 9223372036854775807
  • minInclusive: 0
Integer

Syntax

This is a restriction of the int type.

  • maxInclusive: 2147483647
  • minInclusive: 0
Integer22

Syntax

This is a restriction of the decimal type.

  • totalDigits: 22
  • fractionDigits: 0
PositiveDecimal28_6

Syntax

This is a restriction of the Decimal28_6 type.

  • minInclusive: 0
CurrencyCode

Syntax

This is a restriction of the string type.

  • maxLength: 5
String256

Syntax

This is a restriction of the string type.

  • maxLength: 256
NotEmptyString256

Syntax

This is a restriction of the string type.

  • minLength: 1
  • maxLength: 256
String2000

Syntax

This is a restriction of the string type.

  • maxLength: 2000
Date

Syntax

This is a restriction of the dateTime type.

  • pattern: [0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}
CountryCode

Syntax

This is a restriction of the string type.

  • length: 2
Empty

Syntax

This is a restriction of the string type.

  • length: 0
TableScope

Syntax

This is a restriction of the string type.

The possible values are:

  • agreement
  • both
  • catalog
Status

Syntax

This is a restriction of the String256 type.

The possible values are:

  • open
  • released
  • obsolete
AccountType

Syntax

This is a restriction of the String256 type.

The possible values are:

  • postpaid
  • prepaid
RangeBound

Syntax

This is a restriction of the string type.

The possible values are:

  • exclusive
  • inclusive
LastRange

Syntax

This is a restriction of the string type.

The possible values are:

  • bounded
  • unbounded
ComputationMode

Syntax

This is a restriction of the string type.

The possible values are:

  • single
  • cumulative
  • rangeSizeCumulative
Copyright© 2020 SAP SE or an SAP affiliate company. All rights reserved.