Module saps4hana.itcm.producthierarchy
ballerinax/saps4hana.itcm.producthierarchy Ballerina library
1.2.0
Overview
This is a generated connector for SAPS4HANA Intelligent Trade Claims Management API v1.0.0 OpenAPI specification. In SAPS4HANA Intelligent Trade Claims Management, users can group and organize their products and nodes and assign them to a product hierarchy.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create and configure an OAuth2 client credentials by following this guide.
Clients
saps4hana.itcm.producthierarchy: Client
Isolated
This is a generated connector for SAPS4HANA Intelligent Trade Claims Management API v1.0.0 OpenAPI specification. In SAPS4HANA Intelligent Trade Claims Management, users can group and organize their products and nodes and assign them to a product hierarchy.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Create and configure an OAuth2 client credentials by following this guide.
init (ClientConfig clientConfig, string serviceUrl)- clientConfig ClientConfig - The configurations to be used when initializing the
connector
- serviceUrl string - URL of the target service
createProductHierarchy
Isolated FunctionRemote Function
function createProductHierarchy(HierarchyHeaderEO payload) returns HierarchyCreationResponse|errorCreate a new Product Hierarchy
Parameters
- payload HierarchyHeaderEO - Request payload to create a new product hierarchy
Return Type
- HierarchyCreationResponse|error - Success Created.
getAllNodes
Isolated FunctionRemote Function
function getAllNodes(string externalId) returns HierarchyNodeHeaderResponse|errorGet Product Hierarchy Nodes with header externalId
Parameters
- externalId string - External Id
Return Type
getNode
Isolated FunctionRemote Function
function getNode(string externalId) returns HierarchyNodeResponse|errorGet Product Hierarchy with externalId
Parameters
- externalId string - External Id
Return Type
- HierarchyNodeResponse|error - OK.
deleteProductHierarchyTenant
Isolated FunctionRemote Function
function deleteProductHierarchyTenant(string headerExternalId) returns ResponseDeleteMessage|errorDelete the Product Hierarchy with header externalId
Parameters
- headerExternalId string - Header external Id
Return Type
- ResponseDeleteMessage|error - OK.
Records
saps4hana.itcm.producthierarchy: Action
Fields
- actionPermissionItems ActionPermissionItem[]? -
- enabled boolean? -
- exposed boolean? -
- implCommandCode int? -
- inputParameters InputParameter[]? -
- name string? -
- outputParameter OutputParameter? -
- permission string? -
- requireFullOn string[]? -
- requireReadOn string[]? -
- requiredPermission string? -
- sideEffecting boolean? -
- statical boolean? -
saps4hana.itcm.producthierarchy: ActionPermissionItem
Fields
- id string? -
- permissionId string? -
- value string? -
saps4hana.itcm.producthierarchy: Association
Fields
- allowCustomizeDefaultValue boolean? -
- allowCustomizeLabel boolean? -
- allowCustomizeValidValues boolean? -
- column string? -
- defaultValue string? -
- description string? -
- descriptionChanged boolean? -
- exposed boolean? -
- fullName string? -
- hasCustomerPersonalData boolean? -
- implTargetTable string? -
- label string? -
- labelChanged boolean? -
- mandatory boolean? -
- multiplicity string? -
- name string? -
- namespace string? -
- rawLabel string? -
- 'readonly boolean? -
- targetBOName string? -
- targetBONamespace string? -
- targetPropertyName string? -
- updatable boolean? -
- userDefined boolean? -
saps4hana.itcm.producthierarchy: BusinessObject
Fields
- bo BusinessObject? -
- businessKey BusinessObjectIdentifier? -
- businessKeyValue record {}? -
- businessObjectType BusinessObjectType? -
- changedAssociations Association[]? -
- changedProperties Property[]? -
- id int? -
- identifier BusinessObjectIdentifier? -
- nodeType NodeType? -
- parent BusinessObjectNode? -
- typeCode string? -
saps4hana.itcm.producthierarchy: BusinessObjectIdentifier
Fields
- boName string? -
- boNamespace string? -
- boNodeTypeName string? -
- keyValues record {}? -
- valid boolean? -
saps4hana.itcm.producthierarchy: BusinessObjectNode
Fields
- bo BusinessObject? -
- businessKey BusinessObjectIdentifier? -
- changedAssociations Association[]? -
- changedProperties Property[]? -
- id int? -
- identifier BusinessObjectIdentifier? -
- nodeType NodeType? -
- parent BusinessObjectNode? -
saps4hana.itcm.producthierarchy: BusinessObjectType
Fields
- actions Action[]? -
- analysable boolean? -
- boSetName string? -
- complexTypes ComplexType[]? -
- creatable boolean? -
- customizable boolean? -
- deletable boolean? -
- enumerations EnumType[]? -
- exposed boolean? -
- fullName string? -
- label string? -
- lastModified string? -
- metadataRepository MetadataRepository? -
- name string? -
- namespace string? -
- nodeTypes IterableNodetype? -
- onBOChanges OnBOChange[]? -
- pluralLabel string? -
- rawLabel string? -
- rawPluralLabel string? -
- readable boolean? -
- rootNode NodeType? -
- updatable boolean? -
- userDefined boolean? -
saps4hana.itcm.producthierarchy: BusinessServiceType
Fields
- actions Action[]? -
- fullyQualifiedName string? -
- namespace string? -
- serviceName string? -
- userDefined boolean? -
saps4hana.itcm.producthierarchy: ClientConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth OAuth2ClientCredentialsGrantConfig - Configurations related to client authentication
- httpVersion string(default "1.1") - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects FollowRedirects?(default ()) - Configurations associated with Redirection
- poolConfig PoolConfiguration?(default ()) - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker CircuitBreakerConfig?(default ()) - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig?(default ()) - Configurations associated with retrying
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket?(default ()) - SSL/TLS-related options
saps4hana.itcm.producthierarchy: ComplexType
Fields
- elements Element[]? -
- name string? -
saps4hana.itcm.producthierarchy: Element
Fields
- name string? -
- 'type string? -
saps4hana.itcm.producthierarchy: EnumType
Fields
- exposed boolean? -
- members Member[]? -
- name string? -
saps4hana.itcm.producthierarchy: ErrorInfo
Fields
- _error string? -
- message string? -
- timestamp string? -
- uri string? -
saps4hana.itcm.producthierarchy: HierarchyCreationResponse
Fields
- hierarchyHeader HierarchyHeader? -
- message string? -
- timestamp string? -
saps4hana.itcm.producthierarchy: HierarchyHeader
Fields
- CreatorCode int? -
- Instance int? -
- InternalCreationTime string? -
- InternalUpdateTime string? -
- UpdatorCode int? -
- Version int? -
- bo BusinessObject? -
- businessCodeForMsgReport string? -
- businessKey BusinessObjectIdentifier? -
- businessKeyValue record {}? -
- businessObjectType BusinessObjectType? -
- businessSystem int? -
- externalId string? -
- hierarchyHeaderDescriptions HierarchyHeaderDescription[]? -
- hierarchyNodes HierarchyNode[]? -
- hierarchyType string? -
- identifier BusinessObjectIdentifier? -
- internalId string? -
- isDeleted boolean? -
- parent BusinessObjectNode? -
- typeCode string? -
saps4hana.itcm.producthierarchy: HierarchyHeaderDescription
Fields
- CreatorCode int? -
- Instance int? -
- InternalCreationTime string? -
- InternalUpdateTime string? -
- UpdatorCode int? -
- Version int? -
- bo BusinessObject? -
- businessCodeForMsgReport string? -
- businessKey BusinessObjectIdentifier? -
- businessKeyValue record {}? -
- businessObjectType BusinessObjectType? -
- description string? -
- hierarchyHeader HierarchyHeader? -
- id int? -
- identifier BusinessObjectIdentifier? -
- internalId string? -
- languageKey string? -
- parent BusinessObjectNode? -
- typeCode string? -
saps4hana.itcm.producthierarchy: HierarchyHeaderDescriptionEO
Fields
- description string? -
- languageKey string? -
saps4hana.itcm.producthierarchy: HierarchyHeaderEO
Fields
- businessSystem int? -
- externalId string? -
- hierarchyHeaderDescriptions HierarchyHeaderDescriptionEO[]? -
- hierarchyNodes HierarchyNodeEO[]? -
- hierarchyType string? -
- isDeleted boolean? -
saps4hana.itcm.producthierarchy: HierarchyNode
Fields
- CreatorCode int? -
- Instance int? -
- InternalCreationTime string? -
- InternalUpdateTime string? -
- UpdatorCode int? -
- Version int? -
- bo BusinessObject? -
- businessCodeForMsgReport string? -
- businessKey BusinessObjectIdentifier? -
- businessKeyValue record {}? -
- businessObjectType BusinessObjectType? -
- externalId string? -
- externalIdNodePath string? -
- externalParentId string? -
- hierarchyHeader HierarchyHeader? -
- hierarchyId string? -
- hierarchyNodeAssignments HierarchyNodeAssignment[]? -
- hierarchyNodeDescriptions HierarchyNodeDescription[]? -
- id int? -
- identifier BusinessObjectIdentifier? -
- internalNodeId string? -
- leafNode boolean? -
- nodeLevel int? -
- nodePath string? -
- parent BusinessObjectNode? -
- parentId string? -
- typeCode string? -
saps4hana.itcm.producthierarchy: HierarchyNodeAssignment
Fields
- CreatorCode int? -
- Instance int? -
- InternalCreationTime string? -
- InternalUpdateTime string? -
- UpdatorCode int? -
- Version int? -
- assignmentType string? -
- bo BusinessObject? -
- businessCodeForMsgReport string? -
- businessKey BusinessObjectIdentifier? -
- businessKeyValue record {}? -
- businessObjectType BusinessObjectType? -
- hierarchyNode HierarchyNode? -
- identifier BusinessObjectIdentifier? -
- internalId string? -
- objectId string? -
- parent BusinessObjectNode? -
- typeCode string? -
saps4hana.itcm.producthierarchy: HierarchyNodeAssignmentDTO
Fields
- assignmentType string? -
- objectId string? -
saps4hana.itcm.producthierarchy: HierarchyNodeAssignmentEO
Fields
- assignmentType string? -
- objectId string? -
saps4hana.itcm.producthierarchy: HierarchyNodeDescription
Fields
- CreatorCode int? -
- Instance int? -
- InternalCreationTime string? -
- InternalUpdateTime string? -
- UpdatorCode int? -
- Version int? -
- bo BusinessObject? -
- businessCodeForMsgReport string? -
- businessKey BusinessObjectIdentifier? -
- businessKeyValue record {}? -
- businessObjectType BusinessObjectType? -
- description string? -
- hierarchyNode HierarchyNode? -
- identifier BusinessObjectIdentifier? -
- internalId string? -
- languageKey string? -
- parent BusinessObjectNode? -
- typeCode string? -
saps4hana.itcm.producthierarchy: HierarchyNodeDescriptionDTO
Fields
- description string? -
- languageKey string? -
saps4hana.itcm.producthierarchy: HierarchyNodeDescriptionEO
Fields
- description string? -
- languageKey string? -
saps4hana.itcm.producthierarchy: HierarchyNodeDTO
Fields
- externalId string? -
- externalParentId string? -
- hierarchyNodeAssignments HierarchyNodeAssignmentDTO[]? -
- hierarchyNodeDescriptions HierarchyNodeDescriptionDTO[]? -
- nodeLevel int? -
saps4hana.itcm.producthierarchy: HierarchyNodeEO
Fields
- externalId string? -
- externalNodeIdPath string? -
- externalParentId string? -
- hierarchyNodeAssignments HierarchyNodeAssignmentEO[]? -
- hierarchyNodeDescriptions HierarchyNodeDescriptionEO[]? -
- internalNodeIdPath string? -
- leafNode boolean? -
- nodeLevel int? -
saps4hana.itcm.producthierarchy: HierarchyNodeHeaderResponse
Fields
- hierarchyNodeData HierarchyNodeDTO[]? -
- message string? -
- timestamp string? -
saps4hana.itcm.producthierarchy: HierarchyNodeResponse
Fields
- hierarchyNodeData HierarchyNodeDTO[]? -
- message string? -
- timestamp string? -
saps4hana.itcm.producthierarchy: InputParameter
Fields
- name string? -
- 'type string? -
saps4hana.itcm.producthierarchy: IterableNodetype
saps4hana.itcm.producthierarchy: Member
Fields
- exposed boolean? -
- label string? -
- name string? -
- rawLabel string? -
- validValue string? -
- value int? -
saps4hana.itcm.producthierarchy: MetadataRepository
Fields
- businessObjectTypes BusinessObjectType[]? -
- businessServices BusinessServiceType[]? -
- 'version int? -
saps4hana.itcm.producthierarchy: Node
Fields
- name string? -
- nodeType NodeType? -
- 'type string? -
saps4hana.itcm.producthierarchy: NodeType
Fields
- associations Association[]? -
- businessKey string[]? -
- businessObjectType BusinessObjectType? -
- displayName string[]? -
- exposed boolean? -
- exposedProperties Property[]? -
- extTable string? -
- fullName string? -
- implTable string? -
- label string? -
- name string? -
- nodeSetName string? -
- nodes Node[]? -
- parentKey ParentRef? -
- pluralLabel string? -
- primaryKey string[]? -
- properties Property[]? -
- rawLabel string? -
- rawPluralLabel string? -
- rootNodeType boolean? -
- uniqueConstraints string[]? -
- userDefined boolean? -
- userFieldsMeta Property[]? -
saps4hana.itcm.producthierarchy: OAuth2ClientCredentialsGrantConfig
Closed record
OAuth2 Client Credintials Grant Configs
Fields
- Fields Included from *OAuth2ClientCredentialsGrantConfig
- tokenUrl string
- clientId string
- clientSecret string
- scopes string[]
- defaultTokenExpTime decimal
- clockSkew decimal
- optionalParams map<string>
- credentialBearer CredentialBearer
- clientConfig ClientConfiguration
- tokenUrl string(default "https://dummyurl.com/oauth2/v0") - Token URL
saps4hana.itcm.producthierarchy: OnBOChange
Fields
- bindingPath string? -
- name string? -
saps4hana.itcm.producthierarchy: OutputParameter
Fields
- 'type string? -
saps4hana.itcm.producthierarchy: ParentRef
Fields
- column string? -
- name string? -
saps4hana.itcm.producthierarchy: Property
Fields
- allowCustomizeDefaultValue boolean? -
- allowCustomizeDescription boolean? -
- allowCustomizeLabel boolean? -
- allowCustomizeValidValues boolean? -
- allowCustomizeValidationRule boolean? -
- baseType string? -
- customErrorMessage string? -
- customizable boolean? -
- defaultValue string? -
- description string? -
- descriptionChanged boolean? -
- embedded boolean? -
- embeddedColumnBaseType string? -
- exposed boolean? -
- fullName string? -
- globalSearchResult boolean? -
- globalSearchable boolean? -
- implColumn string? -
- label string? -
- labelChanged boolean? -
- mandatory boolean? -
- name string? -
- namespace string? -
- rawLabel string? -
- readOnly boolean? -
- searchPath string? -
- searchable boolean? -
- sensitive boolean? -
- size int? -
- skipValidation boolean? -
- 'type string? -
- unique boolean? -
- updatable boolean? -
- userDefined boolean? -
- validValues ValidValue[]? -
- validationRule string? -
- valueConverter string? -
saps4hana.itcm.producthierarchy: ResponseDeleteMessage
Fields
- message string? -
- timestamp string? -
saps4hana.itcm.producthierarchy: ResponseForbiddenMessage
Fields
- message string? -
- timestamp string? -
- uri string? -
saps4hana.itcm.producthierarchy: ResponseNotFoundMessage
Fields
- message string? -
- _error string? -
- timestamp string? -
saps4hana.itcm.producthierarchy: ResponseUnauthorizedMessage
Fields
- message string? -
- timestamp string? -
- uri string? -
saps4hana.itcm.producthierarchy: ValidValue
Fields
- deletable boolean? -
- description string? -
- rawDescription string? -
- systemPredefined boolean? -
- value string? -