Documentation

Dive in:

• A note about sales shipments associated with multiple orders

  If you are working with a sales or supply shipment, note that adding multiple sales or supply orders to the shipment at once is not currently supported by the IBM Watson Supply Chain Insights APIs. To add multiple orders to a shipment, you must upload your orders individually, each of them using the unique shipment…

• Advanced options for order management docker-based developer toolkit

  For advanced use of docker-based developer toolkit, you can also run the ./om-compose.sh command with arguments to suit your requirements. For example, ./om-compose.sh <arguments>. For information about the supported arguments, refer the following table: Table 2: Advanced options to run the compose script  Arguments Description  setup <full_path_to_cusom jar> To setup Docker-based Order Management environment for the first…

• Connect and configure an external chat service in IBM Watson Supply Chain Insights

  The API below is a specification that an external chat bot service has to follow. Watson Supply Chain Insights does not provide this API, but in order for an external chat bot to be able to integrate with Watson Supply Chain Insights, it needs to be based on the following template. SCI chat bot API

• Create an SMS Program

  How it Works If you have the SMS UBX Sender feature enabled for your Org you will need to use this API to create SMS Text to Join Programs instead of SMS Campaign Manager. Note:  This API is only available for Orgs that have SMS UBX Sender feature enabled. Use Case Use this REST API…

• Delete an SMS Program

  How it Works If you have the SMS UBX Sender feature enabled for your Org you will need to use this API to delete an SMS Text to Join Program. Note:  This API is only available for Orgs that have SMS UBX Sender feature enabled. Use Case Use this REST API to delete an SMS…

• Docker command reference for Order Management docker-based developer toolkit environment

  The following docker commands help you accomplish common tasks.  Command Description  docker images To see all your images. You will see at least four images corresponding to application server, DB2 server, MQ server, and OMS runtime.  docker ps To see all running containers. You will see at least four active containers corresponding to application server, DB2…

• Exporting SMS messages from the SMS Campaign Manager using a REST API

  Through the use of REST API, you can export sent/received SMS messages from the SMS Campaign Manager to an external system. Overview You can retrieve all SMS messages up to a one year duration. This REST operation returns all SMS based on specified Program ID. Additionally, you can filter the results using the following filters:…

• GDPR Support for Cordova and Xamarin

  IBM Mobile App Messaging supports General Data Protection Regulation (GDPR) requests for erasure. When a GDPR request for erasure is made by a user, Watson Campaign Automation (WCA) customers can use the GDPR Right to Erasure API to erase the user's personal data from WCA, Mobile Customer Engagement (MCE), and the user's device. The API…

• IBM Business Transaction Intelligence

  IBM Business Transaction Intelligence is a cognitive capability of IBM Supply Chain Business Network that provides meaningful information and insights to help companies better manage order to cash and purchase to pay interactions. You can use Business Transaction Intelligence to: View high-level operational information on the dashboard about your supply chain transactions. Visually represent complex…

• IBM Search Insights corpus document endpoints

  You can PUT a JSON array of documents in a body of the request. In a Curl command, use PUT with the –d option and '@' to upload a file from the command line. PUT /service/v1/products PUT /service/v1/articles PUT /service/v1/help PUT /service/v1/services You can post a file of product information to the site that is…

• IBM Watson Commerce

• Installing the iOS SDK by using the CocoaPods dependency manager

  You can add the IBM Mobile App Messaging framework to your app by using the CocoaPods dependency manager. For information about installing the IBM Mobile App Messaging SDK by using CocoaPods, see step 2 in Getting started with the Mobile App Messaging SDK (Objective C) or Getting started with the Mobile App Messaging SDK (Swift).…

• Karix SMS JSON API User Guide

  Overview This guide provides specifications of the JSON based API connectivity provided by Karix (previously known as mGage India) to IBM customers so that they can send their transactional SMS messages quickly. Familiarity and experience with invoking the HTTP API request using JSON payload is necessary to use this API. Note: This API can only be used by…

• KPI names to use for API calls in IBM Watson Supply Chain Insights

  If you want to use APIs to call IBM Watson Supply Chain Insights KPIs, refer to the list below for the correct KPI name format. The names are organized by data type. For example, a call to get all issues related to the SalesOrderDeliveringLate KPI would be formatted as follows: https://supplychaininsights.ibm.com/api/issues?kpi=SalesOrdersDeliveringLate Sales Orders SalesOrdersDeliveringEarly SalesOrdersDeliveringLate…

• Push to Segment API

  Overview Push to Segment API can be used from an external system, but not from the Watson Campaign Automation UI. Content must be defined by the user in Watson Campaign Automation and published. The published message ID will be used as the path parameter for this Push to Segment API. Note: This API is also…

• REST API to get a list of all active SMS programs for an Org

  How it Works Use this API to get a list of all active SMS programs with program attributes for a given Org. Requirements to use this API Your Watson Campaign Automation org must have SMS enabled by provisioning. A database in your Watson Campaign Automation org must have SMS enabled. The user making the API…

• REST API to get an SMS Program status

  How it Works Use this API to get the status and other attributes for a given SMS Program ID. Requirements to use this API Your Watson Campaign Automation org must have SMS enabled by provisioning. A database in your Watson Campaign Automation org must have SMS enabled. The user making the API call must have…

• REST API to get published messages from Watson Campaign Automation

  How it Works Use this REST API to get a list of published messages by channel (SMS or Push) along with given attributes so that the list can be used for further consumption. Messages are listed in order by Date, then by Message ID. If an organization has more than 50 published messages per channel, the first…

• REST API to Send Transactional SMS Messages

  How It Works Use this API to send an SMS message to contact(s) you specify by providing the SMS phone number or a lookup key. SMS messages will only be sent to contacts whose Consent Status in Watson Campaign Automation is Opted-in. This API allows you to personalize the message using a Database field or…

• Supported Controls for Android

  With the Android SDK, you can track every navigation choice, every touched button, and the contents of every field. Quick Links List of supported controls List of unsupported controls List of supported controls Text View ImageView ListView EditText Button toggleButton Spinner FrameLayout ListView CheckBox RadioButton ProgressBar Text View ImageView ListView EditText Button toggleButton Spinner FrameLayout…

• Synonyms in IBM Search Insights

  Synonyms are implemented in IBM Search Insights by mapping a root word to a list of synonymous words. The synonyms are handled directly by Solr, and the root word and its synonyms are specific to a Search Insights instance. Here are a couple of examples of root words and assigned synonyms: Root word: TV Synonyms:…

• Tagging with IBM UBX Capture and DDX

  Great news! IBM UBX Capture and DDX are entirely compatible! Here is how tagging will work when you use IBM UBX Capture. When IBM UBX Capture enables IBM Digital Analytics, DDX tagging is included automatically. Be aware that for an IBM UBX Capture enablement, the library for the enabled application is loaded and DDX does…

• Test your customization changes

  Every time that you change the source files to customize your site, you can test your changes by running unit tests and end to end tests. Unit tests are run by using Karma and the End-to-End tests are run by using Protractor. Unit tests Run the command npm test. The command compiles the application and…

• Update an SMS Program Attribute

  How it Works If you have the SMS UBX Sender feature enabled for your Org you will need to use this API to update attribute(s) of your SMS Text to Join Programs instead of SMS Campaign Manager. Note: This API is only available for Orgs that have SMS UBX Sender feature enabled. Use Case Use…

• Using external APIs in the SMS Campaign Manager

  Create an API template to make an API call to an external system directly from an SMS multi-step program in SMS Campaign Manager. After you create the template, add it as an action in a multi-step program. About this task If trying to connect to any external API other than Watson Campaign Automation, only basic…

• Using the Gateway API to send SMS messages from an external system

  Use the Gateway API 2.0 to trigger SMS messages from an external system, completely bypassing your Watson Campaign Automation organization. Usage You can create this API to send transactional SMS messages, SMS reminders, or any type of SMS messages that are generated from external systems. Note: We recommend that you use the External SMS Consent REST API or the Transactional SMS…

• Using the WebMO API to send a virtual MO to an SMS Program

  The WebMO API allows an external system to send a virtual mobile-originated (MO) message to an SMS Program in the SMS Campaign Manager. Note: This WebMO API is not an XML or REST API. It is invoked with POST method and contains required parameters in a query string. Usage You can use this API to: Enter…

• xapirest.properties

  Use the customer_overrides.properties file to override properties in xapirest.properties.*. The xapirest.properties file allows the same configuration options as yifclient.properties and controls where XAPI calls take place. XAPI calls are set to LOCAL by default. The following table lists custom configurations in xapirest.properties: Property Values Description servlet.authstyle CONTAINER CONTAINER_USER (Default) STANDARD OPEN EXTENDED BASIC CONTAINER requires…

• REST API SMS External Consent

  How it Works The SMS External Consent REST API allows the user to send transactional SMS messages to contacts who might or might not be in the [shortcode-variables slug="wca-med"] SMS database. Use Case This REST API allows sending transactional SMS messages to contacts and who might or might not have SMS consent in the SMS…

• IBM Watson Content Hub

  Overview The IBM Watson Content Hub a cloud-based content management system provides your business the ability to create, store, and retrieve content for your business needs in an effortless way. Watson automatically analyzes images and provides tag suggestions to help make your process easier. You can retrieve the content from the hub by using the…

• IBM Watson Marketing

  IBM® Mobile App Messaging® Mobile App Messaging provide a flexible, easier-to-use environment for creating notification campaigns that engage mobile app users at the optimal time and place. It also provides targeted push messaging that delivers timely notifications to your mobile app users and flexible features that help you engage mobile consumers with relevant content, offers…

• REST API to send SMS to Contact Source

  Use this REST API, along with your OAuth credentials to send a published SMS message to a contact source, with the ability to pass in a message name. How It Works Prerequisites to API SMS send Your Watson Campaign Automation org must have SMS enabled by provisioning. A database in the Watson Campaign Automation org must have SMS…