catalog
Service Operations (Technical Names)
This process component provides the following service operations:
- chargePlanClassFind
- chargePlanClassDescriptionFind
- refillPlanClassFind
- refillPlanClassDescriptionFind
- mappingTableClassFind
- mappingTableCreate
- mappingTableMaintain
- mappingTableCancel
- mappingTableFind
- mappingTableRowMaintain
- mappingTableRowCancel
- mappingTableRowMaintainBundle
- mappingTableRowCancelBundle
- rangeTableClassFind
- rangeTableMaintain
- rangeTableCancel
- rangeTableFind
- rangeTableRangeSetMaintain
- rangeTableRangeSetCancel
- monitoringPlanClassFind
- monitoringPlanClassDescriptionFind
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.
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.
-
windowSize (int, optional)
-
totalCountRequired (boolean, optional, default: "false")Tells the server to indicate the number of unreturned items in the response (the items included in the response itself are not included in the count).
-
id (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
-
description (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
- status (Status, optional, {open | released | obsolete})
-
additionalInfo
...
(AdditionalAttributeDescription, optional, multiple)
- name (String256)
-
- pattern (String256)
-
stringEnumeration (StringEnumeration)
- value ... (String2000, multiple)
-
numberEnumeration (NumberEnumeration)
- value ... (Decimal, multiple)
-
dateEnumeration (DateEnumeration)
- value ... (Date, multiple)
-
numberRange (NumberRange)
-
min (NumberBoundary)
- @included (boolean, default: "true")
-
max (NumberBoundary)
- @included (boolean, default: "true")
-
min (NumberBoundary)
-
dateRange (DateRange)
-
min (DateBoundary)
- @included (boolean, default: "true")
-
max (DateBoundary)
- @included (boolean, default: "true")
-
min (DateBoundary)
-
searchWindow (SearchFilterWindow, optional)
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)Additional message to describe the error or report a warning, in case of success.
-
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)
- name (String256)
- description (String2000, optional)
-
- string (String2000)
- date (Date)
- number (Decimal)
-
parameter
...
(Parameter, optional, multiple)
- name (String256)
- description (String2000, optional)
-
- string (String2000, nillable)
- date (Date, nillable)
- number (Decimal, nillable)
-
additionalInfo
...
(AdditionalInfo, optional, multiple)
- name (String256)
- description (String2000, optional)
-
- string (String2000)
- date (Date)
- number (Decimal)
-
counter
...
(Counter, optional, multiple)
- name (String256)
- description (String2000, optional)
-
accountAssignment
...
(TypedAccountAssignment, optional, multiple)
- name (String256)
- description (String2000, optional)
- type (AccountType, {postpaid | prepaid})
-
userTechnicalIdentifier
...
(ChargePlanClassUserTechnicalIdentifier, optional, multiple)
- name (String256)
- description (String2000, optional)
-
serviceTechnicalIdentifier
...
(ServiceTechnicalIdentifier, multiple)
- name (String256)
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.
-
windowSize (int, optional)
-
totalCountRequired (boolean, optional, default: "false")Tells the server to indicate the number of unreturned items in the response (the items included in the response itself are not included in the count).
-
id (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
-
description (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
- status (Status, optional, {open | released | obsolete})
-
additionalInfo
...
(AdditionalAttributeDescription, optional, multiple)
- name (String256)
-
- pattern (String256)
-
stringEnumeration (StringEnumeration)
- value ... (String2000, multiple)
-
numberEnumeration (NumberEnumeration)
- value ... (Decimal, multiple)
-
dateEnumeration (DateEnumeration)
- value ... (Date, multiple)
-
numberRange (NumberRange)
-
min (NumberBoundary)
- @included (boolean, default: "true")
-
max (NumberBoundary)
- @included (boolean, default: "true")
-
min (NumberBoundary)
-
dateRange (DateRange)
-
min (DateBoundary)
- @included (boolean, default: "true")
-
max (DateBoundary)
- @included (boolean, default: "true")
-
min (DateBoundary)
-
searchWindow (SearchFilterWindow, optional)
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)Additional message to describe the error or report a warning, in case of success.
-
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)
- id (String256)
- owner (String256)
- status (Status, optional, {open | released | obsolete})
- description (String2000, optional)
-
additionalInfo
...
(AdditionalInfo, optional, multiple)
- name (String256)
- description (String2000, optional)
-
- string (String2000)
- date (Date)
- number (Decimal)
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.
-
windowSize (int, optional)
-
totalCountRequired (boolean, optional, default: "false")Tells the server to indicate the number of unreturned items in the response (the items included in the response itself are not included in the count).
-
id (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
-
description (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
- status (Status, optional, {open | released | obsolete})
-
additionalInfo
...
(AdditionalAttributeDescription, optional, multiple)
- name (String256)
-
- pattern (String256)
-
stringEnumeration (StringEnumeration)
- value ... (String2000, multiple)
-
numberEnumeration (NumberEnumeration)
- value ... (Decimal, multiple)
-
dateEnumeration (DateEnumeration)
- value ... (Date, multiple)
-
numberRange (NumberRange)
-
min (NumberBoundary)
- @included (boolean, default: "true")
-
max (NumberBoundary)
- @included (boolean, default: "true")
-
min (NumberBoundary)
-
dateRange (DateRange)
-
min (DateBoundary)
- @included (boolean, default: "true")
-
max (DateBoundary)
- @included (boolean, default: "true")
-
min (DateBoundary)
-
searchWindow (SearchFilterWindow, optional)
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)Additional message to describe the error or report a warning, in case of success.
-
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)
- id (String256)
- owner (String256)
- status (Status, optional, {open | released | obsolete})
- description (String2000, optional)
-
additionalInfo
...
(AdditionalInfo, optional, multiple)
- name (String256)
- description (String2000, optional)
-
- string (String2000)
- date (Date)
- number (Decimal)
-
parameter
...
(Parameter, optional, multiple)
- name (String256)
- description (String2000, optional)
-
- string (String2000, nillable)
- date (Date, nillable)
- number (Decimal, nillable)
-
additionalInfo
...
(AdditionalInfo, optional, multiple)
- name (String256)
- description (String2000, optional)
-
- string (String2000)
- date (Date)
- number (Decimal)
-
counter
...
(Counter, optional, multiple)
- name (String256)
- description (String2000, optional)
-
accountAssignment (AccountAssignment)
- name (String256)
- description (String2000, optional)
-
userTechnicalIdentifier
...
(UserTechnicalIdentifier, optional, multiple)
- name (String256)
- description (String2000, optional)
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.
-
windowSize (int, optional)
-
totalCountRequired (boolean, optional, default: "false")Tells the server to indicate the number of unreturned items in the response (the items included in the response itself are not included in the count).
-
id (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
-
description (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
- status (Status, optional, {open | released | obsolete})
-
additionalInfo
...
(AdditionalAttributeDescription, optional, multiple)
- name (String256)
-
- pattern (String256)
-
stringEnumeration (StringEnumeration)
- value ... (String2000, multiple)
-
numberEnumeration (NumberEnumeration)
- value ... (Decimal, multiple)
-
dateEnumeration (DateEnumeration)
- value ... (Date, multiple)
-
numberRange (NumberRange)
-
min (NumberBoundary)
- @included (boolean, default: "true")
-
max (NumberBoundary)
- @included (boolean, default: "true")
-
min (NumberBoundary)
-
dateRange (DateRange)
-
min (DateBoundary)
- @included (boolean, default: "true")
-
max (DateBoundary)
- @included (boolean, default: "true")
-
min (DateBoundary)
-
searchWindow (SearchFilterWindow, optional)
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)Additional message to describe the error or report a warning, in case of success.
-
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)
- id (String256)
- owner (String256)
- status (Status, optional, {open | released | obsolete})
- description (String2000, optional)
-
additionalInfo
...
(AdditionalInfo, optional, multiple)
- name (String256)
- description (String2000, optional)
-
- string (String2000)
- date (Date)
- number (Decimal)
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 (CatalogSearchFilter)
-
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.
-
windowSize (int, optional)
-
totalCountRequired (boolean, optional, default: "false")Tells the server to indicate the number of unreturned items in the response (the items included in the response itself are not included in the count).
-
id (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
-
description (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
-
additionalInfo
...
(AdditionalAttributeDescription, optional, multiple)
- name (String256)
-
- pattern (String256)
-
stringEnumeration (StringEnumeration)
- value ... (String2000, multiple)
-
numberEnumeration (NumberEnumeration)
- value ... (Decimal, multiple)
-
dateEnumeration (DateEnumeration)
- value ... (Date, multiple)
-
numberRange (NumberRange)
-
min (NumberBoundary)
- @included (boolean, default: "true")
-
max (NumberBoundary)
- @included (boolean, default: "true")
-
min (NumberBoundary)
-
dateRange (DateRange)
-
min (DateBoundary)
- @included (boolean, default: "true")
-
max (DateBoundary)
- @included (boolean, default: "true")
-
min (DateBoundary)
-
searchWindow (SearchFilterWindow, optional)
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)Additional message to describe the error or report a warning, in case of success.
-
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)
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:
- id (String256)
- mappingTableClassId (String256)
-
additionalInfo
...
(AdditionalInfo, optional, multiple)
- name (String256)
- description (String2000, optional)
-
- string (String2000)
- date (Date)
- number (Decimal)
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)Additional message to describe the error or report a warning, in case of success.
-
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)The business identifier of the mapping table affected by this operation (identical to the one given in the query).
-
reference (String256, optional)The database identifier (primary key) of the mapping table affected by this 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:
- id (String256)
- description (String2000, optional)
-
additionalInfo
...
(AdditionalInfo, optional, multiple)
- name (String256)
- description (String2000, optional)
-
- string (String2000)
- date (Date)
- number (Decimal)
- tableClassId (String256)
- agreementId (String256, optional)
-
row
...
(MappingTableRow, optional, multiple)
- id (String256)
- start (Date)
- end (Date)
-
column
...
(MappingTableColumn, multiple)
- name (String256)
-
- string (String2000)
- currency (String2000)
- number (Decimal)
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)Additional message to describe the error or report a warning, in case of success.
-
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)The business identifier of the mapping table affected by this operation (identical to the one given in the query).
-
reference (String256, optional)The database identifier (primary key) of the mapping table affected by this operation.
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)Additional message to describe the error or report a warning, in case of success.
-
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)The business identifier of the mapping table affected by this operation (identical to the one given in the query).
-
reference (String256, optional)The database identifier (primary key) of the mapping table affected by this 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 (CatalogTableSearchFilter)
-
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.
-
windowSize (int, optional)
-
totalCountRequired (boolean, optional, default: "false")Tells the server to indicate the number of unreturned items in the response (the items included in the response itself are not included in the count).
-
id (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
-
description (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
-
additionalInfo
...
(AdditionalAttributeDescription, optional, multiple)
- name (String256)
-
- pattern (String256)
-
stringEnumeration (StringEnumeration)
- value ... (String2000, multiple)
-
numberEnumeration (NumberEnumeration)
- value ... (Decimal, multiple)
-
dateEnumeration (DateEnumeration)
- value ... (Date, multiple)
-
numberRange (NumberRange)
-
min (NumberBoundary)
- @included (boolean, default: "true")
-
max (NumberBoundary)
- @included (boolean, default: "true")
-
min (NumberBoundary)
-
dateRange (DateRange)
-
min (DateBoundary)
- @included (boolean, default: "true")
-
max (DateBoundary)
- @included (boolean, default: "true")
-
min (DateBoundary)
-
tableClassId (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
-
agreementId (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
- tableScope (TableScope, optional, default: "catalog", {agreement | both | catalog})
-
omitRows (boolean, optional, default: "false")Set this flag to true when you want the table's rows to be omitted from the response.
-
searchWindow (SearchFilterWindow, optional)
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)Additional message to describe the error or report a warning, in case of success.
-
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)
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:
- mappingTableId (String256)
-
row
...
(MappingTableRow, multiple)
- id (String256)
- start (Date)
- end (Date)
-
column
...
(MappingTableColumn, multiple)
- name (String256)
-
- string (String2000)
- currency (String2000)
- number (Decimal)
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)Additional message to describe the error or report a warning, in case of success.
-
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)
Message Type: mappingTableRowCancelRequest
Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.
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)Additional message to describe the error or report a warning, in case of success.
-
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)
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)Additional message to describe the error or report a warning, in case of success.
-
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))
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)Additional message to describe the error or report a warning, in case of success.
-
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))
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 (CatalogSearchFilter)
-
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.
-
windowSize (int, optional)
-
totalCountRequired (boolean, optional, default: "false")Tells the server to indicate the number of unreturned items in the response (the items included in the response itself are not included in the count).
-
id (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
-
description (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
-
additionalInfo
...
(AdditionalAttributeDescription, optional, multiple)
- name (String256)
-
- pattern (String256)
-
stringEnumeration (StringEnumeration)
- value ... (String2000, multiple)
-
numberEnumeration (NumberEnumeration)
- value ... (Decimal, multiple)
-
dateEnumeration (DateEnumeration)
- value ... (Date, multiple)
-
numberRange (NumberRange)
-
min (NumberBoundary)
- @included (boolean, default: "true")
-
max (NumberBoundary)
- @included (boolean, default: "true")
-
min (NumberBoundary)
-
dateRange (DateRange)
-
min (DateBoundary)
- @included (boolean, default: "true")
-
max (DateBoundary)
- @included (boolean, default: "true")
-
min (DateBoundary)
-
searchWindow (SearchFilterWindow, optional)
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)Additional message to describe the error or report a warning, in case of success.
-
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)
-
additionalInfo
...
(AdditionalInfo, optional, multiple)
- name (String256)
- description (String2000, optional)
-
- string (String2000)
- date (Date)
- number (Decimal)
- rangeUpperBound (RangeBound, {exclusive | inclusive})
- lastRange (LastRange, {bounded | unbounded})
-
outputColumn
...
(RangeTableClassOutputColumn, multiple (max: 100))
- name (String256)
- description (String2000, optional)
-
- string (String256, nillable)
-
number (RangeTableClassDecimalOutputColumn, nillable)
- @computationMode (ComputationMode, default: "single", {single | cumulative | rangeSizeCumulative})
-
inputColumn
...
(RangeTableClassInputColumn, optional, multiple (max: 100))
- name (String256)
- description (String2000, optional)
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:
- id (String256)
- description (String2000, optional)
-
additionalInfo
...
(AdditionalInfo, optional, multiple)
- name (String256)
- description (String2000, optional)
-
- string (String2000)
- date (Date)
- number (Decimal)
- tableClassId (String256)
- agreementId (String256, optional)
- date (Date, optional)
-
rangeSet
...
(RangeTableRangeSet, multiple)
- rangeSetKey (RangeTableRangeSetKey, optional)
-
range
...
(RangeTableRange, multiple)
-
- upperBound (PositiveDecimal)
- unbounded (no type, nillable)
-
outputColumn
...
(RangeTableColumn, multiple (max: 100))
- name (String256)
-
- string (String2000)
- number (Decimal)
-
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)Additional message to describe the error or report a warning, in case of success.
-
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)The business identifier of the range table affected by this operation (identical to the one given in the query).
-
reference (String256, optional)The database identifier (primary key) of the range table affected by this operation.
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)Additional message to describe the error or report a warning, in case of success.
-
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)The business identifier of the range table affected by this operation (identical to the one given in the query).
-
reference (String256, optional)The database identifier (primary key) of the range table affected by this 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 (CatalogTableSearchFilter)
-
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.
-
windowSize (int, optional)
-
totalCountRequired (boolean, optional, default: "false")Tells the server to indicate the number of unreturned items in the response (the items included in the response itself are not included in the count).
-
id (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
-
description (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
-
additionalInfo
...
(AdditionalAttributeDescription, optional, multiple)
- name (String256)
-
- pattern (String256)
-
stringEnumeration (StringEnumeration)
- value ... (String2000, multiple)
-
numberEnumeration (NumberEnumeration)
- value ... (Decimal, multiple)
-
dateEnumeration (DateEnumeration)
- value ... (Date, multiple)
-
numberRange (NumberRange)
-
min (NumberBoundary)
- @included (boolean, default: "true")
-
max (NumberBoundary)
- @included (boolean, default: "true")
-
min (NumberBoundary)
-
dateRange (DateRange)
-
min (DateBoundary)
- @included (boolean, default: "true")
-
max (DateBoundary)
- @included (boolean, default: "true")
-
min (DateBoundary)
-
tableClassId (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
-
agreementId (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
- tableScope (TableScope, optional, default: "catalog", {agreement | both | catalog})
-
omitRows (boolean, optional, default: "false")Set this flag to true when you want the table's rows to be omitted from the response.
-
searchWindow (SearchFilterWindow, optional)
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)Additional message to describe the error or report a warning, in case of success.
-
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)
-
additionalInfo
...
(AdditionalInfo, optional, multiple)
- name (String256)
- description (String2000, optional)
-
- string (String2000)
- date (Date)
- number (Decimal)
- tableClassId (String256)
- agreementId (String256, optional)
-
revisions
...
(RangeTableRevision, optional, multiple)
- validityStartDate (Date, optional)
- validityEndDate (Date, optional)
-
rangeSet
...
(RangeTableRangeSet, multiple)
- rangeSetKey (RangeTableRangeSetKey, optional)
-
range
...
(RangeTableRange, multiple)
-
- upperBound (PositiveDecimal)
- unbounded (no type, nillable)
-
outputColumn
...
(RangeTableColumn, multiple (max: 100))
- name (String256)
-
- string (String2000)
- number (Decimal)
-
Message Type: rangeTableRangeSetMaintainRequest
Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.
Structure
The rangeTableRangeSetMaintainRequest message type is structured as follows:
- date (Date, optional)
- rangeTableId (String256)
-
rangeSet
...
(RangeTableRangeSet, multiple)
- rangeSetKey (RangeTableRangeSetKey, optional)
-
range
...
(RangeTableRange, multiple)
-
- upperBound (PositiveDecimal)
- unbounded (no type, nillable)
-
outputColumn
...
(RangeTableColumn, multiple (max: 100))
- name (String256)
-
- string (String2000)
- number (Decimal)
-
Message Type: rangeTableRangeSetMaintainResponse
Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.
Structure
The rangeTableRangeSetMaintainResponse message type is structured as follows:
- status (ResponseStatus, {return | error | inProgress})
-
message (string, optional)Additional message to describe the error or report a warning, in case of success.
-
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)The business identifier of the range table affected by this operation (identical to the one given in the query).
-
reference (String256, optional)The database identifier (primary key) of the range table affected by this operation.
Message Type: rangeTableRangeSetCancelRequest
Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.
Message Type: rangeTableRangeSetCancelResponse
Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.
Structure
The rangeTableRangeSetCancelResponse message type is structured as follows:
- status (ResponseStatus, {return | error | inProgress})
-
message (string, optional)Additional message to describe the error or report a warning, in case of success.
-
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)The business identifier of the range table affected by this operation (identical to the one given in the query).
-
reference (String256, optional)The database identifier (primary key) of the range table affected by this 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.
-
windowSize (int, optional)
-
totalCountRequired (boolean, optional, default: "false")Tells the server to indicate the number of unreturned items in the response (the items included in the response itself are not included in the count).
-
id (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
-
description (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
- status (Status, optional, {open | released | obsolete})
-
additionalInfo
...
(AdditionalAttributeDescription, optional, multiple)
- name (String256)
-
- pattern (String256)
-
stringEnumeration (StringEnumeration)
- value ... (String2000, multiple)
-
numberEnumeration (NumberEnumeration)
- value ... (Decimal, multiple)
-
dateEnumeration (DateEnumeration)
- value ... (Date, multiple)
-
numberRange (NumberRange)
-
min (NumberBoundary)
- @included (boolean, default: "true")
-
max (NumberBoundary)
- @included (boolean, default: "true")
-
min (NumberBoundary)
-
dateRange (DateRange)
-
min (DateBoundary)
- @included (boolean, default: "true")
-
max (DateBoundary)
- @included (boolean, default: "true")
-
min (DateBoundary)
-
searchWindow (SearchFilterWindow, optional)
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)Additional message to describe the error or report a warning, in case of success.
-
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)
- name (String256)
- description (String2000, optional)
-
- string (String2000)
- date (Date)
- number (Decimal)
-
counter
...
(Counter, optional, multiple)
- name (String256)
- description (String2000, optional)
-
spendingStatusDescription
...
(SpendingStatusDescription, optional, multiple)
- name (String256)
- description (String2000, optional)
-
userTechnicalIdentifier
...
(UserTechnicalIdentifier, optional, multiple)
- name (String256)
- description (String2000, optional)
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.
-
windowSize (int, optional)
-
totalCountRequired (boolean, optional, default: "false")Tells the server to indicate the number of unreturned items in the response (the items included in the response itself are not included in the count).
-
id (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
-
description (StringAttributeDescription, optional)
-
-
enumeration (StringEnumeration)
- value ... (String2000, multiple)
- pattern (String256)
-
enumeration (StringEnumeration)
-
- status (Status, optional, {open | released | obsolete})
-
additionalInfo
...
(AdditionalAttributeDescription, optional, multiple)
- name (String256)
-
- pattern (String256)
-
stringEnumeration (StringEnumeration)
- value ... (String2000, multiple)
-
numberEnumeration (NumberEnumeration)
- value ... (Decimal, multiple)
-
dateEnumeration (DateEnumeration)
- value ... (Date, multiple)
-
numberRange (NumberRange)
-
min (NumberBoundary)
- @included (boolean, default: "true")
-
max (NumberBoundary)
- @included (boolean, default: "true")
-
min (NumberBoundary)
-
dateRange (DateRange)
-
min (DateBoundary)
- @included (boolean, default: "true")
-
max (DateBoundary)
- @included (boolean, default: "true")
-
min (DateBoundary)
-
searchWindow (SearchFilterWindow, optional)
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)Additional message to describe the error or report a warning, in case of success.
-
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)
- id (String256)
- owner (String256)
- status (Status, optional, {open | released | obsolete})
- description (String2000, optional)
-
additionalInfo
...
(AdditionalInfo, optional, multiple)
- name (String256)
- description (String2000, optional)
-
- string (String2000)
- date (Date)
- number (Decimal)
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
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