Module saps4hana.wls.screeninghits
ballerinax/saps4hana.wls.screeninghits Ballerina library
Overview
The SAP S/4HANA SAP Watch List Screening Hits API v1.7 connector(https://api.sap.com/api/ScreeningHits/resource) OpenAPI specification.
This microservice manages Screening Hits created by the Screening microservice and enables users to decide whether they are true matches or false positives. The Screening Hits are grouped in Screening Hit Collections. The Screening Hit Collection refers to a Business Context e.g. a Sales Order and contains one or more Screened Addresses.
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.wls.screeninghits: Client
This is a generated connector for SAPS4HANA SAP Watch List Screening Hits API v1.7 OpenAPI specification. This microservice manages Screening Hits created by the Screening microservice and enables users to decide whether they are true matches or false positives. The Screening Hits are grouped in Screening Hit Collections. The Screening Hit Collection refers to a Business Context e.g. a Sales Order and contains one or more Screened Addresses.
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
get
function get(string filter) returns ScreeningDecisions|errorWith the parameter screeningRequestKey as input, this API provides the current decision status of a ScreeningHitCollection. This is essential for either blocking or releasing the business transaction.
Parameters
- filter string - Filter containing the UUID of the screening request, for example
screeningRequestKey eq 'be9828a4-6992-11e8-adc0-fa7ae01bbebc'
Return Type
- ScreeningDecisions|error - Screening Decisions
put
function put(string screeningRequestKey, BusinessContext payload) returns Response|errorIn some cases, you may want to post the initial screening request without the businessContext and add it later on. For example, when you screen your business document before it has been persisted, it may not have a documentId yet, and you may want to amend that once saving has been completed. PUT the /screeningHitCollections resource with the screeningRequestKey received in response to the screeningRequest to set the businessContext.
Parameters
- screeningRequestKey string - UUID of the screening request
- payload BusinessContext - Business context
delete
function delete(string date, boolean logicalDelete) returns DeletionResult|errorTo remove old screening hits whose business purpose is fullfilled, you need to delete screeningHitCollections that are older than the effective date and also have the status Completed. Use the query parameter logicalDelete to remove the hits physically from storage (logicalDelete=false) or only logically (logicalDelete=true), meaning they are still there but no longer displayed in the user interfaces.
Parameters
- date string - Screening hits created before this date are deleted (effective date, format YYYY-MM-DD (ISO8601) in UTC).
- logicalDelete boolean - Screening hits are logically deleted
Return Type
- DeletionResult|error - Deletion successful
getBPData
function getBPData(string name, string? street, string? city, string? countryISOCode, string? postalCode, boolean logicalDeleteIncluded) returns BusinessPartners|errorGet Business Partner Data
Parameters
- name string - Name of the business partner
- street string? (default ()) - Street
- city string? (default ()) - City
- countryISOCode string? (default ()) - Country ISO Code
- postalCode string? (default ()) - Postal Code
- logicalDeleteIncluded boolean (default false) - Include logically deleted business partners
Return Type
- BusinessPartners|error - Business Partner
Records
saps4hana.wls.screeninghits: BusinessContext
Fields
- businessSystem? string - Business System
- businessObjectType? string - The type of business object whose business partners are screened. Possible values are
SOfor Sales Order,ODfor Outbound Delivery,POfor Purchase Order,PCfor Purchase Contract,PAfor Purchase Scheduling Agreement,SCfor Sales Contract,SAfor Sales Scheduling Agreement,APMPAYMENTREQUESTfor Payment,SQfor Sales Quotation,IDfor Inbound Delivery andPRfor Purchase Requisition.
- documentId? string - Document ID
saps4hana.wls.screeninghits: BusinessPartner
Fields
- name? string -
- street? string -
- city? string -
- countryISOCode? string -
- postalCode? string -
- inputKey? string -
- logicalDelete? boolean -
- logicalDeleteOn? string - Date on which the record was logically deleted in UTC
saps4hana.wls.screeninghits: ClientHttp1Settings
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.wls.screeninghits: ConnectionConfig
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.wls.screeninghits: DeletionResult
Fields
- number? int - Number of (logically) deleted records
- text? string - Description of deletion result
saps4hana.wls.screeninghits: Error
Fields
- code? string - Error code
- message? string - Error text
saps4hana.wls.screeninghits: OAuth2ClientCredentialsGrantConfig
OAuth2 Client Credentials Grant Configs
Fields
- Fields Included from *OAuth2ClientCredentialsGrantConfig
- tokenUrl string(default "https://sap-wls.authentication.eu10.hana.ondemand.com/oauth/token") - Token URL
saps4hana.wls.screeninghits: ProxyConfig
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.wls.screeninghits: ScreeningDecision
Fields
- inputKey? string - Externally provided Key of Business Partner Input
- status? string - Screening Hit Decision [ N - No Hit, C - Confirmed Hit, P - Possible Hit]
Array types
saps4hana.wls.screeninghits: BusinessPartners
BusinessPartners
Business Partners
saps4hana.wls.screeninghits: ScreeningDecisions
ScreeningDecisions
Screening Decisions