Module saps4hana.itcm.customerhierarchy
ballerinax/saps4hana.itcm.customerhierarchy Ballerina library
1.5.2
Overview
The SAP S/4HANA Intelligent Trade Claims Management API v1.0.0 connector(https://help.sap.com/viewer/902b9d277dfe48fea582d28849d54935/CURRENT/en-US) OpenAPI specification. In SAP Intelligent Trade Claims Management, users can group and organize their customers and nodes and assign them to a customer hierarchy.
Key Features
- Programmatic access to create and manage resources via REST API
- Manage user accounts and profiles
- Secure authentication with API key or OAuth support
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.customerhierarchy: Client
Isolated
This is a generated connector for SAP Intelligent Trade Claims Management API v1.0.0 OpenAPI specification. In SAP Intelligent Trade Claims Management, users can group and organize their customers and nodes and assign them to a customer 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 (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.dev1.e2e.eurekacloud.io/v1" - URL of the target service
createCustomerHierarchy
Isolated FunctionRemote Function
function createCustomerHierarchy(HierarchyHeaderEO payload) returns HierarchyCreationResponse|errorCreate a new Customer Hierarchy
Parameters
- payload HierarchyHeaderEO - Request payload to create customer hierarchy
Return Type
- HierarchyCreationResponse|error - Success Created.
getAllNodes
Isolated FunctionRemote Function
function getAllNodes(string externalId) returns HierarchyNodeHeaderResponse|errorGet Customer Hierarchy Nodes with header externalId
Parameters
- externalId string - External Id
Return Type
getNode
Isolated FunctionRemote Function
function getNode(string externalId) returns HierarchyNodeResponse|errorGet Customer Hierarchy Nodes with externalId
Parameters
- externalId string - External Id
Return Type
- HierarchyNodeResponse|error - OK.
deleteCustomerHierarchy
Isolated FunctionRemote Function
function deleteCustomerHierarchy(string headerExternalId) returns ResponseDeleteMessage|errorDelete a Customer Hierarchy Entity with externalId
Parameters
- headerExternalId string - Header external Id
Return Type
- ResponseDeleteMessage|error - OK.
Records
saps4hana.itcm.customerhierarchy: 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.customerhierarchy: ActionPermissionItem
Fields
- id? string -
- permissionId? string -
- value? string -
saps4hana.itcm.customerhierarchy: 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.customerhierarchy: 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.customerhierarchy: BusinessObjectIdentifier
Fields
- boName? string -
- boNamespace? string -
- boNodeTypeName? string -
- keyValues? record {} -
- valid? boolean -
saps4hana.itcm.customerhierarchy: BusinessObjectNode
Fields
- bo? BusinessObject -
- businessKey? BusinessObjectIdentifier -
- changedAssociations? Association[] -
- changedProperties? Property[] -
- id? int -
- identifier? BusinessObjectIdentifier -
- nodeType? NodeType -
- parent? BusinessObjectNode -
saps4hana.itcm.customerhierarchy: 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.customerhierarchy: BusinessServiceType
Fields
- actions? Action[] -
- fullyQualifiedName? string -
- namespace? string -
- serviceName? string -
- userDefined? boolean -
saps4hana.itcm.customerhierarchy: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy? ProxyConfig - Proxy server related options
saps4hana.itcm.customerhierarchy: ComplexType
Fields
- elements? Element[] -
- name? string -
saps4hana.itcm.customerhierarchy: ConnectionConfig
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 HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol
- http2Settings? ClientHttp2Settings - 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
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache? CacheConfig - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
saps4hana.itcm.customerhierarchy: Element
Fields
- name? string -
- 'type? string -
saps4hana.itcm.customerhierarchy: EnumType
Fields
- exposed? boolean -
- members? Member[] -
- name? string -
saps4hana.itcm.customerhierarchy: HierarchyCreationResponse
Fields
- hierarchyHeader? HierarchyHeader -
- message? string -
- timestamp? string -
saps4hana.itcm.customerhierarchy: 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.customerhierarchy: 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.customerhierarchy: HierarchyHeaderDescriptionEO
Fields
- description? string -
- languageKey? string -
saps4hana.itcm.customerhierarchy: HierarchyHeaderEO
Fields
- businessSystem? int -
- externalId? string -
- hierarchyHeaderDescriptions? HierarchyHeaderDescriptionEO[] -
- hierarchyNodes? HierarchyNodeEO[] -
- hierarchyType? string -
- isDeleted? boolean -
saps4hana.itcm.customerhierarchy: 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.customerhierarchy: 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.customerhierarchy: HierarchyNodeAssignmentDTO
Fields
- assignmentType? string -
- objectId? string -
saps4hana.itcm.customerhierarchy: HierarchyNodeAssignmentEO
Fields
- assignmentType? string -
- objectId? string -
saps4hana.itcm.customerhierarchy: 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.customerhierarchy: HierarchyNodeDescriptionDTO
Fields
- description? string -
- languageKey? string -
saps4hana.itcm.customerhierarchy: HierarchyNodeDescriptionEO
Fields
- description? string -
- languageKey? string -
saps4hana.itcm.customerhierarchy: HierarchyNodeDTO
Fields
- externalId? string -
- externalParentId? string -
- hierarchyNodeAssignments? HierarchyNodeAssignmentDTO[] -
- hierarchyNodeDescriptions? HierarchyNodeDescriptionDTO[] -
- nodeLevel? int -
saps4hana.itcm.customerhierarchy: HierarchyNodeEO
Fields
- externalId? string -
- externalNodeIdPath? string -
- externalParentId? string -
- hierarchyNodeAssignments? HierarchyNodeAssignmentEO[] -
- hierarchyNodeDescriptions? HierarchyNodeDescriptionEO[] -
- internalNodeIdPath? string -
- leafNode? boolean -
- nodeLevel? int -
saps4hana.itcm.customerhierarchy: HierarchyNodeHeaderResponse
Fields
- hierarchyNodeData? HierarchyNodeDTO[] -
- message? string -
- timestamp? string -
saps4hana.itcm.customerhierarchy: HierarchyNodeResponse
Fields
- hierarchyNodeData? HierarchyNodeDTO[] -
- message? string -
- timestamp? string -
saps4hana.itcm.customerhierarchy: InputParameter
Fields
- name? string -
- 'type? string -
saps4hana.itcm.customerhierarchy: IterableNodetype
saps4hana.itcm.customerhierarchy: Member
Fields
- exposed? boolean -
- label? string -
- name? string -
- rawLabel? string -
- validValue? string -
- value? int -
saps4hana.itcm.customerhierarchy: MetadataRepository
Fields
- businessObjectTypes? BusinessObjectType[] -
- businessServices? BusinessServiceType[] -
- 'version? int -
saps4hana.itcm.customerhierarchy: Node
Fields
- name? string -
- nodeType? NodeType -
- 'type? string -
saps4hana.itcm.customerhierarchy: 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.customerhierarchy: OAuth2ClientCredentialsGrantConfig
Closed record
OAuth2 Client Credentials Grant Configs
Fields
- Fields Included from *OAuth2ClientCredentialsGrantConfig
- tokenUrl string(default "https://colgate-dev1.authentication.us30.hana.ondemand.com/oauth/token") - Token URL
saps4hana.itcm.customerhierarchy: OnBOChange
Fields
- bindingPath? string -
- name? string -
saps4hana.itcm.customerhierarchy: OutputParameter
Fields
- 'type? string -
saps4hana.itcm.customerhierarchy: ParentRef
Fields
- column? string -
- name? string -
saps4hana.itcm.customerhierarchy: 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.customerhierarchy: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
saps4hana.itcm.customerhierarchy: ResponseDeleteMessage
Fields
- message? string -
- timestamp? string -
saps4hana.itcm.customerhierarchy: ResponseForbiddenMessage
Fields
- message? string -
- timestamp? string -
- uri? string -
saps4hana.itcm.customerhierarchy: ResponseNotFoundMessage
Fields
- message? string -
- 'error? string -
- timestamp? string -
saps4hana.itcm.customerhierarchy: ResponseUnauthorizedMessage
Fields
- message? string -
- timestamp? string -
- uri? string -
saps4hana.itcm.customerhierarchy: ValidValue
Fields
- deletable? boolean -
- description? string -
- rawDescription? string -
- systemPredefined? boolean -
- value? string -