saps4hana.itcm.organizationaldata
Module saps4hana.itcm.organizationaldata
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_saps4hana.itcm.organizationaldata_1.5.0.png)
ballerinax/saps4hana.itcm.organizationaldata Ballerina library
Overview
This is a generated connector for SAPS4HANA Intelligent Trade Claims Management API v1.0.0 OpenAPI specification. SAP Intelligent Trade Claims Management uses the organizational data services to represent distribution channel services, sales areas, sales divisions, and sales organizations for customer management.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create and configure an OAuth2 client credentials by following this guide.
Clients![](/images/permalink.svg)
saps4hana.itcm.organizationaldata: Client![](/images/permalink.svg)
This is a generated connector for SAPS4HANA Intelligent Trade Claims Management API v1.0.0 OpenAPI specification. SAP Intelligent Trade Claims Management uses the organizational data services to represent distribution channel services, sales areas, sales divisions, and sales organizations for customer management.
Constructor![](/images/permalink.svg)
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 - URL of the target service
createDistributionChannel![](/images/permalink.svg)
function createDistributionChannel(ExternalDistributionChannelDTO payload) returns ResponseCreated|error
Create a new Distribution Channel
Parameters
- payload ExternalDistributionChannelDTO - Request payload to create distribution channel
Return Type
- ResponseCreated|error - Success Created.
getDistributionChannelByExternalId![](/images/permalink.svg)
function getDistributionChannelByExternalId(string externalId) returns DistributionChannelResponse|error
Get particular Distribution Channel
Parameters
- externalId string - externalId
Return Type
deleteDistributionChannel![](/images/permalink.svg)
function deleteDistributionChannel(string externalId) returns DistributionChannelDeleteResponse|error
Delete particular Distribution Channel
Parameters
- externalId string - externalId
Return Type
createSalesArea![](/images/permalink.svg)
function createSalesArea(ExternalSalesAreaDTO payload) returns ResponseCreated|error
Create a new Sales Area
Parameters
- payload ExternalSalesAreaDTO - Request payload to create a sales area
Return Type
- ResponseCreated|error - Success Created.
getSalesAreaByExternalId![](/images/permalink.svg)
function getSalesAreaByExternalId(string externalId) returns SalesAreaResponse|error
Get particular Sales Area
Parameters
- externalId string - externalId
Return Type
- SalesAreaResponse|error - OK.
deleteSalesArea![](/images/permalink.svg)
function deleteSalesArea(string externalId) returns SalesAreaDeleteResponse|error
Delete particular Sales Area
Parameters
- externalId string - externalId
Return Type
- SalesAreaDeleteResponse|error - OK.
createSalesDivision![](/images/permalink.svg)
function createSalesDivision(ExternalSalesDivisionDTO payload) returns ResponseCreated|error
Create a new Sales Division
Parameters
- payload ExternalSalesDivisionDTO - salesDivisionDTO
Return Type
- ResponseCreated|error - Success Created.
getSalesDivisionByExternalId![](/images/permalink.svg)
function getSalesDivisionByExternalId(string externalId) returns SalesDivisionResponse|error
Get particular Sales Division
Parameters
- externalId string - externalId
Return Type
- SalesDivisionResponse|error - OK.
deleteSalesDivision![](/images/permalink.svg)
function deleteSalesDivision(string externalId) returns SalesDivisionDeleteResponse|error
delete particular Sales Division
Parameters
- externalId string - externalId
Return Type
createSalesOrganization![](/images/permalink.svg)
function createSalesOrganization(ExternalSalesOrganizationDTO payload) returns ResponseCreated|error
Create a new Sales Organization
Parameters
- payload ExternalSalesOrganizationDTO - Request payload to create sales organization
Return Type
- ResponseCreated|error - Success Created.
getSalesOrganizationByExternalId![](/images/permalink.svg)
function getSalesOrganizationByExternalId(string externalId) returns SalesOrganizationResponse|error
Get particular Sales Organization
Parameters
- externalId string - externalId
Return Type
deleteSalesOrganization![](/images/permalink.svg)
function deleteSalesOrganization(string externalId) returns SalesOrgDeleteResponse|error
Delete particular Sales Organization
Parameters
- externalId string - externalId
Return Type
Records![](/images/permalink.svg)
saps4hana.itcm.organizationaldata: ClientHttp1Settings![](/images/permalink.svg)
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.organizationaldata: ConnectionConfig![](/images/permalink.svg)
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-forwarded
header
- 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.organizationaldata: DistributionChannelDeleteResponse![](/images/permalink.svg)
Fields
- message string? -
- externalid string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: DistributionChannelResponse![](/images/permalink.svg)
Fields
- 'distribution\-channels ExternalDistributionChannelDTO? -
- externalid string? -
- message string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: DistributionChannelResponseNotFound![](/images/permalink.svg)
Fields
- message string? -
- externalid string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: ExternalDistributionChannelDescriptionDTO![](/images/permalink.svg)
Fields
- description string? -
- languageKey string? -
saps4hana.itcm.organizationaldata: ExternalDistributionChannelDTO![](/images/permalink.svg)
Fields
- descriptions ExternalDistributionChannelDescriptionDTO[]? -
- externalId string -
saps4hana.itcm.organizationaldata: ExternalSalesAreaDescriptionDTO![](/images/permalink.svg)
Fields
- description string? -
- languageKey string? -
saps4hana.itcm.organizationaldata: ExternalSalesAreaDTO![](/images/permalink.svg)
Fields
- descriptions ExternalSalesAreaDescriptionDTO[]? -
- externalDistributionChannel string? -
- externalId string -
- externalSalesDivision string? -
- externalSalesOrganization string? -
saps4hana.itcm.organizationaldata: ExternalSalesDivisionDescriptionDTO![](/images/permalink.svg)
Fields
- description string? -
- languageKey string? -
saps4hana.itcm.organizationaldata: ExternalSalesDivisionDTO![](/images/permalink.svg)
Fields
- descriptions ExternalSalesDivisionDescriptionDTO[]? -
- externalId string -
saps4hana.itcm.organizationaldata: ExternalSalesOrganizationDescriptionDTO![](/images/permalink.svg)
Fields
- description string? -
- languageKey string? -
saps4hana.itcm.organizationaldata: ExternalSalesOrganizationDTO![](/images/permalink.svg)
Fields
- descriptions ExternalSalesOrganizationDescriptionDTO[]? -
- externalCompanyCodeId string? -
- externalId string -
saps4hana.itcm.organizationaldata: OAuth2ClientCredentialsGrantConfig![](/images/permalink.svg)
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.organizationaldata: ProxyConfig![](/images/permalink.svg)
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.organizationaldata: ResponseCreated![](/images/permalink.svg)
Fields
- externalId string? -
- message string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: ResponseForbiddenMessage![](/images/permalink.svg)
Fields
- message string? -
- timestamp string? -
- uri string? -
saps4hana.itcm.organizationaldata: ResponseMessage![](/images/permalink.svg)
Fields
- message string? -
- uri string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: ResponseNotFoundMessage![](/images/permalink.svg)
Fields
- message string? -
- 'error string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: ResponseUnauthorizedMessage![](/images/permalink.svg)
Fields
- message string? -
- timestamp string? -
- uri string? -
saps4hana.itcm.organizationaldata: SalesAreaDeleteResponse![](/images/permalink.svg)
Fields
- externalid string? -
- message string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: SalesAreaResponse![](/images/permalink.svg)
Fields
- externalid string? -
- message string? -
- 'sales\-areas ExternalSalesAreaDTO? -
- timestamp string? -
saps4hana.itcm.organizationaldata: SalesAreaResponseNotFound![](/images/permalink.svg)
Fields
- count int? -
- 'distribution\-channels ExternalDistributionChannelDTO[]? -
- message string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: SalesDivisionDeleteResponse![](/images/permalink.svg)
Fields
- externalid string? -
- message string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: SalesDivisionResponse![](/images/permalink.svg)
Fields
- externalid string? -
- message string? -
- 'sales\-divisions ExternalSalesDivisionDTO? -
- timestamp string? -
saps4hana.itcm.organizationaldata: SalesDivisionResponseNotFound![](/images/permalink.svg)
Fields
- count int? -
- 'distribution\-channels ExternalDistributionChannelDTO[]? -
- message string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: SalesOrganizationDeleteResponse![](/images/permalink.svg)
Fields
- externalid string? -
- message string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: SalesOrganizationResponse![](/images/permalink.svg)
Fields
- externalId string? -
- message string? -
- 'sales\-organization ExternalSalesOrganizationDTO? -
- timestamp string? -
saps4hana.itcm.organizationaldata: SalesOrganizationResponseNotFound![](/images/permalink.svg)
Fields
- count int? -
- 'distribution\-channels ExternalDistributionChannelDTO[]? -
- message string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: SalesOrgDeleteResponse![](/images/permalink.svg)
Fields
- externalid string? -
- message string? -
- timestamp string? -
Import
import ballerinax/saps4hana.itcm.organizationaldata;
Metadata
Released date: over 1 year ago
Version: 1.5.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.4.1
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Business Management/ERP
Cost/Paid
Contributors