Module saps4hana.itcm.organizationaldata
ballerinax/saps4hana.itcm.organizationaldata Ballerina library
1.5.1
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
saps4hana.itcm.organizationaldata: Client
Isolated
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
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
Isolated FunctionRemote Function
function createDistributionChannel(ExternalDistributionChannelDTO payload) returns ResponseCreated|errorCreate a new Distribution Channel
Parameters
- payload ExternalDistributionChannelDTO - Request payload to create distribution channel
Return Type
- ResponseCreated|error - Success Created.
getDistributionChannelByExternalId
Isolated FunctionRemote Function
function getDistributionChannelByExternalId(string externalId) returns DistributionChannelResponse|errorGet particular Distribution Channel
Parameters
- externalId string - externalId
Return Type
deleteDistributionChannel
Isolated FunctionRemote Function
function deleteDistributionChannel(string externalId) returns DistributionChannelDeleteResponse|errorDelete particular Distribution Channel
Parameters
- externalId string - externalId
Return Type
createSalesArea
Isolated FunctionRemote Function
function createSalesArea(ExternalSalesAreaDTO payload) returns ResponseCreated|errorCreate a new Sales Area
Parameters
- payload ExternalSalesAreaDTO - Request payload to create a sales area
Return Type
- ResponseCreated|error - Success Created.
getSalesAreaByExternalId
Isolated FunctionRemote Function
function getSalesAreaByExternalId(string externalId) returns SalesAreaResponse|errorGet particular Sales Area
Parameters
- externalId string - externalId
Return Type
- SalesAreaResponse|error - OK.
deleteSalesArea
Isolated FunctionRemote Function
function deleteSalesArea(string externalId) returns SalesAreaDeleteResponse|errorDelete particular Sales Area
Parameters
- externalId string - externalId
Return Type
- SalesAreaDeleteResponse|error - OK.
createSalesDivision
Isolated FunctionRemote Function
function createSalesDivision(ExternalSalesDivisionDTO payload) returns ResponseCreated|errorCreate a new Sales Division
Parameters
- payload ExternalSalesDivisionDTO - salesDivisionDTO
Return Type
- ResponseCreated|error - Success Created.
getSalesDivisionByExternalId
Isolated FunctionRemote Function
function getSalesDivisionByExternalId(string externalId) returns SalesDivisionResponse|errorGet particular Sales Division
Parameters
- externalId string - externalId
Return Type
- SalesDivisionResponse|error - OK.
deleteSalesDivision
Isolated FunctionRemote Function
function deleteSalesDivision(string externalId) returns SalesDivisionDeleteResponse|errordelete particular Sales Division
Parameters
- externalId string - externalId
Return Type
createSalesOrganization
Isolated FunctionRemote Function
function createSalesOrganization(ExternalSalesOrganizationDTO payload) returns ResponseCreated|errorCreate a new Sales Organization
Parameters
- payload ExternalSalesOrganizationDTO - Request payload to create sales organization
Return Type
- ResponseCreated|error - Success Created.
getSalesOrganizationByExternalId
Isolated FunctionRemote Function
function getSalesOrganizationByExternalId(string externalId) returns SalesOrganizationResponse|errorGet particular Sales Organization
Parameters
- externalId string - externalId
Return Type
deleteSalesOrganization
Isolated FunctionRemote Function
function deleteSalesOrganization(string externalId) returns SalesOrgDeleteResponse|errorDelete particular Sales Organization
Parameters
- externalId string - externalId
Return Type
Records
saps4hana.itcm.organizationaldata: 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.organizationaldata: 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.organizationaldata: DistributionChannelDeleteResponse
Fields
- message string? -
- externalid string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: DistributionChannelResponse
Fields
- 'distribution\-channels ExternalDistributionChannelDTO? -
- externalid string? -
- message string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: DistributionChannelResponseNotFound
Fields
- message string? -
- externalid string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: ExternalDistributionChannelDescriptionDTO
Fields
- description string? -
- languageKey string? -
saps4hana.itcm.organizationaldata: ExternalDistributionChannelDTO
Fields
- descriptions ExternalDistributionChannelDescriptionDTO[]? -
- externalId string -
saps4hana.itcm.organizationaldata: ExternalSalesAreaDescriptionDTO
Fields
- description string? -
- languageKey string? -
saps4hana.itcm.organizationaldata: ExternalSalesAreaDTO
Fields
- descriptions ExternalSalesAreaDescriptionDTO[]? -
- externalDistributionChannel string? -
- externalId string -
- externalSalesDivision string? -
- externalSalesOrganization string? -
saps4hana.itcm.organizationaldata: ExternalSalesDivisionDescriptionDTO
Fields
- description string? -
- languageKey string? -
saps4hana.itcm.organizationaldata: ExternalSalesDivisionDTO
Fields
- descriptions ExternalSalesDivisionDescriptionDTO[]? -
- externalId string -
saps4hana.itcm.organizationaldata: ExternalSalesOrganizationDescriptionDTO
Fields
- description string? -
- languageKey string? -
saps4hana.itcm.organizationaldata: ExternalSalesOrganizationDTO
Fields
- descriptions ExternalSalesOrganizationDescriptionDTO[]? -
- externalCompanyCodeId string? -
- externalId string -
saps4hana.itcm.organizationaldata: 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.organizationaldata: 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.organizationaldata: ResponseCreated
Fields
- externalId string? -
- message string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: ResponseForbiddenMessage
Fields
- message string? -
- timestamp string? -
- uri string? -
saps4hana.itcm.organizationaldata: ResponseMessage
Fields
- message string? -
- uri string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: ResponseNotFoundMessage
Fields
- message string? -
- 'error string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: ResponseUnauthorizedMessage
Fields
- message string? -
- timestamp string? -
- uri string? -
saps4hana.itcm.organizationaldata: SalesAreaDeleteResponse
Fields
- externalid string? -
- message string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: SalesAreaResponse
Fields
- externalid string? -
- message string? -
- 'sales\-areas ExternalSalesAreaDTO? -
- timestamp string? -
saps4hana.itcm.organizationaldata: SalesAreaResponseNotFound
Fields
- count int? -
- 'distribution\-channels ExternalDistributionChannelDTO[]? -
- message string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: SalesDivisionDeleteResponse
Fields
- externalid string? -
- message string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: SalesDivisionResponse
Fields
- externalid string? -
- message string? -
- 'sales\-divisions ExternalSalesDivisionDTO? -
- timestamp string? -
saps4hana.itcm.organizationaldata: SalesDivisionResponseNotFound
Fields
- count int? -
- 'distribution\-channels ExternalDistributionChannelDTO[]? -
- message string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: SalesOrganizationDeleteResponse
Fields
- externalid string? -
- message string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: SalesOrganizationResponse
Fields
- externalId string? -
- message string? -
- 'sales\-organization ExternalSalesOrganizationDTO? -
- timestamp string? -
saps4hana.itcm.organizationaldata: SalesOrganizationResponseNotFound
Fields
- count int? -
- 'distribution\-channels ExternalDistributionChannelDTO[]? -
- message string? -
- timestamp string? -
saps4hana.itcm.organizationaldata: SalesOrgDeleteResponse
Fields
- externalid string? -
- message string? -
- timestamp string? -