IBM Bluemix Lift Activities API

Live

IBM Bluemix Lift Activities API

+ Day(s) remaining in the trial

Overview

### Integrating the Data Load REST API into your application To integrate the Data Load REST API into your application, complete these steps: 1. To create a Data Load activity, invoke the POST method on the service_binding_URL/dc/v1/activities URL with a valid request payload. 2. To run the Data Load activity, invoke the POST method on the service_binding_URL/dc/v1/activities/activity_ID/activityRuns URL. 3. Optional: To monitor the progress of the activity run, invoke the GET method on the service_binding_URL/dc/v1/activities/activity_ID/activityRuns/run_ID URL. ### Activity Connection Payloads Reference these connection details when constructing your Activity payload. ``` "db2Connection": { "database": "string", "gateway": "string", "host": "string", "instance": "string", "password": "string", "port": 0, "schema": "string", "type": "db2", "user": "string", "lift": "[{\"name\":\"liftagent.securetoken\",\"value\":\"\"}, {\"name\":\"liftagent.host\",\"value\":\"\"}, {\"name\":\"liftagent.port\",\"value\":\"\"}, {\"name\":\"liftagent.asperaratelimit\",\"value\":}, {\"name\":\"liftagent.asperacheck\",\"value\":}]" }, "liftCSVConnection": { "gateway": "string", "schema": "string", "type": "liftcsv", "lift": "[{\"name\":\"liftagent.securetoken\",\"value\":\"\"}, {\"name\":\"liftagent.host\",\"value\":\"\"}, {\"name\":\"liftagent.port\",\"value\":\"\"}, {\"name\":\"liftagent.asperaratelimit\",\"value\":}, {\"name\":\"liftagent.asperacheck\",\"value\":}]" }, "netezzaConnection": { "database": "string", "gateway": "string", "host": "string", "password": "string", "port": 0, "schema": "string", "type": "netezza", "user": "string", "lift": "[{\"name\":\"liftagent.securetoken\",\"value\":\"\"}, {\"name\":\"liftagent.host\",\"value\":\"\"}, {\"name\":\"liftagent.port\",\"value\":\"\"}, {\"name\":\"liftagent.asperaratelimit\",\"value\":}, {\"name\":\"liftagent.asperacheck\",\"value\":}]" }, "dashDBConnection": { "name": "string", "host": "string", "database": "string", "port": 0, "schema": "string", "username": "string", "password": "string", "type": "dashdb" }, "db2CloudConnection": { "database": "string", "host": "string", "instance": "string", "password": "string", "port": 0, "schema": "string", "ssl": false, "sslCert": "string", "type": "db2cloud", "user": "string" } } ```

Security

Keys

Pick a key to use with this API. Make sure you are logged in with your IBM id for your keys to be populated in the dropdown below. By selecting a key, it will be pre-filled for each endpoint in the Documentation section that can be used with the built-in testing. If you want to change which key to use for a particular endpoint, you can do so at the endpoint in the Documentation section.
You can manage your API keys in the <MyAPIs> section. API keys authenticate you to your subscription, so make sure to keep them secret. Do not share the X-IBM-Client-Secret portion of any API key in publicly accessible places such as GitHub, or client-side code.



Manage your keys
 

Documentation

IBM Bluemix Lift Activities API:

Activities API v3.0

Create an Activity
A request payload for a Data Load activity contains connection information and options for the sources and targets that are involved in the activity. First, specify an activity `name` and `description`. The name must be different than the name for any other activity that you created. Within the `sources` array, specify information for one or more sources: Within the `connection` object for each source, specify connection information for the source. If Analytics for Apache Hadoop is the source, the value of the `host` member must be the host name rather than the IP address. If the source is on-premises, set the `gateway` member to the configuration ID that was provided when you added the secure gateway. Within the `tables` array, specify the tables to provision data from. You must specify one or more source tables. Within the `columns` array, specify the columns to provision data from. If Analytics for Apache Hadoop, Amazon S3, or SoftLayer Object Storage is the source, you must specify the columns. If you specify columns, only the columns that you specify are provisioned to the target. Then specify options for the sources to provision data from. If the source is Analytics for Apache Hadoop, Amazon S3, or SoftLayer Object Storage, set the `firstLineHeader` member to true if the first row does not contain data. Within the `targets` array, specify information for one or more targets: Within the `connection` object, specify connection information for the target. If Analytics for Apache Hadoop is the target, the value of the host member must be the host name rather than the IP address. Within the `tables` array, specify the table to provision data into. The target table is mapped to the source table based on the value of the id element. For example, if the `id` of the source table that you want to map the target table to is s1, you set the datasetId element for the target table to "s1" as well. Within the `columns` array, specify the columns to create in the table. You must specify a column on the target table only if the column is of a `LONGVARBINARY`, `LONGVARCHAR`, or `WLONGVARCHAR` data type. The response to the method includes a location header and a `URL` member that indicates the location of the activity that was created. The response also includes a `runsURL` member, which shows the URL that you can use to run the activity.

POST   /v1

			https://service.binding.ur/ibm/dataworks/activities/v1
		
Keys
Header parameters

X-HTTP-Method-Override

HEADER , optional

Path and Query parameters

source

STRING , optional

Existing Activity ID to copy from.

Request code
								
HttpResponse<String> response = Unirest.post("https://ibm.com/ibm/dataworks/activities/v1?source=string") .header("x-http-method-override", "string") .header("accept", "application/json;charset=utf-8") .header("content-type", "application/json;charset=utf-8") .body("{\"docType\":\"string\",\"isSchedulable\":true,\"activityScheduleSummary\":{\"description\":\"The Activity Schedule Summary (Response only)\",\"xml\":{\"name\":\"activityScheduleSummary\"},\"properties\":{\"schedules\":[{\"id\":\"string\",\"startDate\":\"string\",\"invocationNextDate\":\"string\",\"status\":\"string\",\"invocationCount\":0,\"scheduleURL\":\"string\",\"endDate\":\"string\",\"repeat\":{\"description\":\"The repeat information for this Schedule\",\"xml\":{\"name\":\"activityScheduleSummaryRepeat\"},\"properties\":{\"interval\":0,\"repeatWeeks\":[null],\"type\":\"string\",\"repeatDays\":[null]},\"type\":\"object\"}}]},\"type\":\"object\"},\"isPausable\":true,\"expirationDelay\":\"string\",\"isCancellable\":true,\"isSuspendable\":true,\"lastModifiedUser\":\"string\",\"version\":\"string\",\"id\":\"string\",\"runsURL\":\"string\",\"inputDocument\":{\"description\":\"The current Activity Input Document\",\"xml\":{\"name\":\"inputDocument\"},\"properties\":{\"sourceOptions\":{\"description\":\"Options to apply to the activity source\",\"xml\":{\"name\":\"sourceOptions\"},\"properties\":{\"nullValueHandling\":\"string\",\"firstLineHeader\":true,\"relatedTablesData\":true,\"fieldDelimiter\":\"string\",\"customNullValueText\":\"string\",\"timeFormat\":\"%hh:%nn:%ss\",\"blobTruncationSize\":0,\"rowDelimiter\":\"string\",\"readMode\":\"string\",\"codepage\":0,\"escapeTarget\":\"string\",\"clobTruncationSize\":0,\"quoteCharacter\":\"string\",\"encoding\":\"UTF-8\",\"nullValue\":\"string\",\"timeStampFormat\":\"%yyyy-%mm-%dd %hh:%nn:%ss\",\"dateFormat\":\"%yyyy-%mm-%dd\",\"structureInFirstRow\":\"string\",\"incremental\":true,\"fileStructure\":\"string\",\"fieldDelimiterChar\":\"string\",\"rowLimit\":0,\"fileFormat\":\"string\"},\"type\":\"object\"},\"shapingPipelines\":[null],\"targetOptions\":{\"description\":\"Options to apply to the activity target\",\"xml\":{\"name\":\"targetOptions\"},\"properties\":{\"hiveTable\":\"string\",\"customHiveTableSuffix\":\"string\",\"customHiveTablePrefix\":\"string\",\"blobTruncationSize\":0,\"folderId\":\"string\",\"customTablePrefix\":\"string\",\"assetId\":\"string\",\"hiveTableSchemaCustomName\":true,\"clobTruncationSize\":0,\"inputFormat\":\"string\",\"hiveTableSchemaName\":\"string\",\"specifyHiveTableSchema\":true,\"customFileSuffix\":\"string\",\"customFilePrefix\":\"string\",\"customTableSuffix\":\"string\",\"createHiveTable\":true,\"existingTablesAction\":\"string\"},\"type\":\"object\"},\"batchProfilingEnabled\":true,\"datasetOption\":\"string\",\"sources\":[{\"id\":\"string\",\"tables\":[{\"id\":\"string\",\"name\":\"string\",\"datasetId\":\"string\",\"columns\":[{\"scale\":0,\"precision\":0,\"description\":\"string\",\"name\":\"string\",\"isNullable\":true,\"type\":\"string\"}],\"sourceIds\":[null]}],\"connection\":{\"description\":\"The source connection\",\"xml\":{\"name\":\"connection\"},\"properties\":{\"port\":0,\"region\":\"string\",\"accessKey\":\"string\",\"gateway\":\"string\",\"bucket\":\"string\",\"userid\":\"string\",\"folderPath\":\"string\",\"ssl\":true,\"refreshtoken\":\"string\",\"projectId\":\"string\",\"collection\":\"string\",\"type\":\"string\",\"password\":\"string\",\"hiveSslEnabled\":true,\"schema\":\"string\",\"id\":\"string\",\"description\":\"string\",\"loginUrl\":\"string\",\"tenantid\":\"string\",\"hivePassword\":\"string\",\"serviceenvironment\":\"string\",\"sid\":\"string\",\"accesstoken\":\"string\",\"host\":\"string\",\"hivePort\":0,\"authToken\":\"string\",\"lastUpdated\":\"string\",\"hiveHost\":\"string\",\"hiveUser\":\"string\",\"database\":\"string\",\"sslCert\":\"string\",\"hiveDb\":\"string\",\"saveCredentials\":true,\"secretKey\":\"string\",\"container\":\"string\",\"authUrl\":\"string\",\"connectionUrl\":\"string\",\"lift\":[null],\"server\":\"string\",\"user\":\"string\"},\"type\":\"object\"}}],\"targets\":[{\"id\":\"string\",\"tables\":[{\"id\":\"string\",\"name\":\"string\",\"datasetId\":\"string\",\"columns\":[{\"scale\":0,\"precision\":0,\"description\":\"string\",\"name\":\"string\",\"isNullable\":true,\"type\":\"string\"}],\"sourceIds\":[null]}],\"connection\":{\"description\":\"The target connection\",\"xml\":{\"name\":\"connection\"},\"properties\":{\"port\":0,\"region\":\"string\",\"accessKey\":\"string\",\"gateway\":\"string\",\"bucket\":\"string\",\"userid\":\"string\",\"folderPath\":\"string\",\"ssl\":true,\"refreshtoken\":\"string\",\"projectId\":\"string\",\"collection\":\"string\",\"type\":\"string\",\"password\":\"string\",\"hiveSslEnabled\":true,\"schema\":\"string\",\"id\":\"string\",\"description\":\"string\",\"loginUrl\":\"string\",\"tenantid\":\"string\",\"hivePassword\":\"string\",\"serviceenvironment\":\"string\",\"sid\":\"string\",\"accesstoken\":\"string\",\"host\":\"string\",\"hivePort\":0,\"authToken\":\"string\",\"lastUpdated\":\"string\",\"hiveHost\":\"string\",\"hiveUser\":\"string\",\"database\":\"string\",\"sslCert\":\"string\",\"hiveDb\":\"string\",\"saveCredentials\":true,\"secretKey\":\"string\",\"container\":\"string\",\"authUrl\":\"string\",\"connectionUrl\":\"string\",\"lift\":[null],\"server\":\"string\",\"user\":\"string\"},\"type\":\"object\"},\"report\":\"string\",\"ddl\":\"string\",\"profile\":true}]},\"type\":\"object\"},\"schedulesURL\":\"string\",\"createdTimeStamp\":\"string\",\"shortDescription\":\"string\",\"lastModifiedTimeStamp\":\"string\",\"createdTool\":\"string\",\"name\":\"string\",\"createdByServiceType\":\"string\",\"URL\":\"string\",\"isRunContinuously\":true,\"activityRunSummary\":{\"description\":\"The current Activity Run Summary (Response only)\",\"xml\":{\"name\":\"activityDetails\"},\"properties\":{\"latestCompletionDate\":\"string\",\"latestStatus\":\"string\",\"runningFromScheduler\":true,\"running\":true,\"latestSubmitDate\":\"string\"},\"type\":\"object\"},\"createdUser\":\"string\"}") .asString();
Request model

docType

STRING , optional

Used to identify activity documents

isSchedulable

BOOLEAN , optional

If the Activity is Schedulable

activityScheduleSummary

object , optional

The Activity Schedule Summary (Response only)

schedules

ARRAY , optional

Schedules for this Activity

id

STRING , optional

The ID of this Schedule

startDate

STRING , optional

The date this Schedule will start

invocationNextDate

STRING , optional

The next Schedule invocation date

status

STRING , optional

The status information for this Schedule

invocationCount

INTEGER , optional

The number of times this Schedule has been invoked

scheduleURL

STRING , optional

The URL of this Schedule

endDate

STRING , optional

The date this Schedule will end

repeat

object , optional

The repeat information for this Schedule

interval

INTEGER , optional

The interval at which the schedule should repeat

repeatWeeks

ARRAY , optional

The weeks of the month when the Activity is scheduled to run

type

STRING , optional

The units used for the interval

repeatDays

ARRAY , optional

The days of the week when the Activity is scheduled to run

isPausable

BOOLEAN , optional

If the Activity is Pausable

expirationDelay

STRING , optional

The time (in hours) after which the activity will be automatically deleted from the system. Use the value 'never' to prevent the activity from expiring

isCancellable

BOOLEAN , optional

If the Activity is Cancellable

isSuspendable

BOOLEAN , optional

If the Activity is Suspendable

lastModifiedUser

STRING , optional

The user that last modified the object (Response only)

version

STRING , optional

The version of the activity schema being used

id

STRING , optional

The ID of the object (Response only)

runsURL

STRING , optional

The URL that can be used to get the list of runs for this activity (Response only)

inputDocument

object , required

The current Activity Input Document

sourceOptions

object , optional

Options to apply to the activity source

nullValueHandling

STRING , optional

Get the null value handling (Hadoop, Lift, S3, Swift, WebHDFS)

firstLineHeader

BOOLEAN , optional

Indicates whether header information, such as column names, is specified in the first row of the file (Hadoop, Lift, S3, Swift, WebHDFS)

relatedTablesData

BOOLEAN , optional

Whether to include data from related tables (DB2)

fieldDelimiter

STRING , optional

Get the field delimiter (Hadoop, Lift, S3, Swift, WebHDFS)

customNullValueText

STRING , optional

Get the custom null value text (Hadoop, Lift, S3, Swift, WebHDFS)

timeFormat

STRING , optional

The time format. The default is %hh:%nn:%ss (Hadoop, Lift, S3, Swift, WebHDFS)

blobTruncationSize

INTEGER , optional

The Blob Truncation Size (DB2)

rowDelimiter

STRING , optional

Get the row delimiter (Hadoop, Lift, S3, Swift, WebHDFS)

readMode

STRING , optional

Whether to read a single file or multiple files (S3)

codepage

INTEGER , optional

Get the code page (Lift)

escapeTarget

STRING , optional

Get the escape target (Hadoop)

clobTruncationSize

INTEGER , optional

The Clob Truncation Size (DB2)

quoteCharacter

STRING , optional

Get the quote character (Hadoop, Lift, S3, Swift, WebHDFS)

encoding

STRING , optional

The file encoding, for example, UTF-8 (Hadoop, Lift, S3, Swift, WebHDFS)

nullValue

STRING , optional

Get the null value (Hadoop, Lift, S3, Swift, WebHDFS)

timeStampFormat

STRING , optional

The timestamp format. The default is %yyyy-%mm-%dd %hh:%nn:%ss (Hadoop, Lift, S3, Swift, WebHDFS)

dateFormat

STRING , optional

The date format. The default is %yyyy-%mm-%dd (Hadoop, Lift, S3, Swift, WebHDFS)

structureInFirstRow

STRING , optional

Indicates whether header information, such as column names, is specified in the first row of the file (Hadoop, Lift, S3, Swift, WebHDFS)

incremental

BOOLEAN , optional

Whether the source data should be migrated incrementally (DB2, Lift, Netezza)

fileStructure

STRING , optional

Get the file structure (Hadoop, Lift, S3, Swift, WebHDFS)

fieldDelimiterChar

STRING , optional

Get the field delimiter char (Hadoop, Lift, S3, Swift, WebHDFS)

rowLimit

INTEGER , optional

Get the row limit (DB2, Netezza)

fileFormat

STRING , optional

Get the file format (Hadoop, Lift, S3, Swift, WebHDFS)

shapingPipelines

ARRAY , optional

Shaping Pipelines

OBJECT , optional

Represents a shaping pipeline

targetOptions

object , optional

Options to apply to the activity target

hiveTable

STRING , optional

The hive table name to use when writing data using the hive connection (WebHDFS)

customHiveTableSuffix

STRING , optional

The custom Hive table suffix (Hadoop)

customHiveTablePrefix

STRING , optional

The custom Hive table prefix (Hadoop)

blobTruncationSize

INTEGER , optional

The Blob Truncation Size (Cloudant)

folderId

STRING , optional

Parent Folder Id, typically a UUID (Watson Analytics)

customTablePrefix

STRING , optional

A prefix to add to the names of target tables. This value applies when target table names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (RDBMS)

assetId

STRING , optional

Asset Id, typically a UUID (Watson Analytics)

hiveTableSchemaCustomName

BOOLEAN , optional

Custom name for the Hive table schema (Hadoop)

clobTruncationSize

INTEGER , optional

The Clob Truncation Size (Cloudant)

inputFormat

STRING , optional

The input format (Cloudant)

hiveTableSchemaName

STRING , optional

The Hive table schema name (Hadoop)

specifyHiveTableSchema

BOOLEAN , optional

Specify the Hive Table Schema (Hadoop)

customFileSuffix

STRING , optional

A suffix to add to the names of target files. This value applies when target files names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (Cloudant, Swift)

customFilePrefix

STRING , optional

A prefix to add to the names of target files. This value applies when target files names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (Cloudant, Swift)

customTableSuffix

STRING , optional

A suffix to add to the names of target tables. This value applies when target table names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (RDBMS)

createHiveTable

BOOLEAN , optional

Whether the hive table should be created or not (WebHDFS)

existingTablesAction

STRING , optional

The action to perform when the target tables already exist (RDBMS)

batchProfilingEnabled

BOOLEAN , optional

Whether Batch Profiling is enabled or not

datasetOption

STRING , optional

The action to perform for source/target datasets

sources

ARRAY , optional

A collection of source physical data resources

id

STRING , optional

The object Id

tables

ARRAY , optional

The collection of tables

id

STRING , optional

The object id

name

STRING , optional

The object display name

datasetId

STRING , optional

The dataset id referenced by this table (only applicable for target tables and only for v3.0 and later)

columns

ARRAY , optional

The table columns

scale

INTEGER , optional

The column scale

precision

INTEGER , optional

The column precision

description

STRING , optional

The column description

name

STRING , optional

The column name

isNullable

BOOLEAN , optional

Whether the column is nullable

type

STRING , optional

The column type

sourceIds

ARRAY , optional

The source ids referenced by this table (only applicable for target tables and only for v2.7 and earlier. For v3.0 this is only supported as a legacy field)

connection

object , optional

The source connection

port

INTEGER , optional

The connection port

region

STRING , optional

The region for this connection

accessKey

STRING , optional

The accessKey for this connection

gateway

STRING , optional

The secure gateway for this connection

bucket

STRING , optional

The bucket for this connection

userid

STRING , optional

The user id (This is different to the user/username and is only required for Bluemix Object Storage currently)

folderPath

STRING , optional

The folder path for this connection

ssl

BOOLEAN , optional

Whether to use ssl for this connection

refreshtoken

STRING , optional

The refresh token for this connection

projectId

STRING , optional

The projectId for this connection

collection

STRING , optional

The collection for this connection

type

STRING , optional

The type of this connection

password

STRING , optional

The connection password

hiveSslEnabled

BOOLEAN , optional

Whether Hive SSL is enabled for this connection

schema

STRING , optional

The connection database schema

id

STRING , optional

The id of this connection

description

STRING , optional

A description of this connection

loginUrl

STRING , optional

The URL to use to access this connection

tenantid

STRING , optional

The tenantid for a butterfly connection

hivePassword

STRING , optional

The Hive Password to use for this connection

serviceenvironment

STRING , optional

The datalake service environment of this connection

sid

STRING , optional

The Oracle sid

accesstoken

STRING , optional

The access token for this connection

host

STRING , optional

The connection host

hivePort

INTEGER , optional

The Hive Port to use for this connection

authToken

STRING , optional

The auth token for this connection

lastUpdated

STRING , optional

When the connection was last updated

hiveHost

STRING , optional

The Hive Host to use for this connection

hiveUser

STRING , optional

The Hive User to use for this connection

database

STRING , optional

The connection database

sslCert

STRING , optional

The self-signed SSL certificate of the database server must be specified in the PEM X.509 format. Only use this property if the ssl property is specified, set to true and if the database server uses an SSL certificate that is not signed by the known CA authority.

hiveDb

STRING , optional

The Hive Database to use for this connection

saveCredentials

BOOLEAN , optional

Whether to save the credentials for this connection

secretKey

STRING , optional

The secret key for this connection

container

STRING , optional

The container for this connection

authUrl

STRING , optional

The auth url for this connection

connectionUrl

STRING , optional

The URL to use to access this connection

lift

ARRAY , optional

The lift details of this connection

server

STRING , optional

The server for this connection

user

STRING , optional

The connection user

targets

ARRAY , optional

A collection of target physical data resources

id

STRING , optional

The object Id

tables

ARRAY , optional

The collection of tables

connection

OBJECT , optional

report

STRING , optional

The DDL conversion report for use with Lift. (Lift only)

ddl

STRING , optional

The DDL for use with Lift (Lift only)

profile

BOOLEAN , optional

Whether the target should be profiled

schedulesURL

STRING , optional

The URL that can be used to get the schedule for this activity (Response only)

createdTimeStamp

STRING , optional

The timestamp when the object was created, in the format yyyy-MM-dd'T'HH:mm:ss.SSS (Response only)

shortDescription

STRING , optional

The description of the object

lastModifiedTimeStamp

STRING , optional

The timestamp when the object was last modified, in the format yyyy-MM-dd'T'HH:mm:ss.SSS (Response only)

createdTool

STRING , optional

The tool used that created the object (Response only)

name

STRING , required

The object name

createdByServiceType

STRING , optional

The service type that created the object (Response only)

URL

STRING , optional

The URL that can be used to get the object (Response only)

isRunContinuously

BOOLEAN , optional

If the Activity is to run continuously

activityRunSummary

object , optional

The current Activity Run Summary (Response only)

latestCompletionDate

STRING , optional

The latest run completion date

latestStatus

STRING , optional

The most recent status of the activity run

runningFromScheduler

BOOLEAN , optional

Whether this activity is running from the Scheduler or not

running

BOOLEAN , optional

Whether this activity is currently running or not

latestSubmitDate

STRING , optional

The latest run submission date

createdUser

STRING , optional

The user that created the object (Response only)

Request example
{
  "docType": string,
  "isSchedulable": boolean,
  "activityScheduleSummary": {
    "schedules": [{
    "id": string,
    "startDate": string,
    "invocationNextDate": string,
    "status": string,
    "invocationCount": integer,
    "scheduleURL": string,
    "endDate": string,
    "repeat": {
    "interval": integer,
    "repeatWeeks": [],
    "type": string,
    "repeatDays": []
  }
  }]
  },
  "isPausable": boolean,
  "expirationDelay": string,
  "isCancellable": boolean,
  "isSuspendable": boolean,
  "lastModifiedUser": string,
  "version": string,
  "id": string,
  "runsURL": string,
  "inputDocument": {
    "sourceOptions": {
    "nullValueHandling": string,
    "firstLineHeader": boolean,
    "relatedTablesData": boolean,
    "fieldDelimiter": string,
    "customNullValueText": string,
    "timeFormat": string,
    "blobTruncationSize": integer,
    "rowDelimiter": string,
    "readMode": string,
    "codepage": integer,
    "escapeTarget": string,
    "clobTruncationSize": integer,
    "quoteCharacter": string,
    "encoding": string,
    "nullValue": string,
    "timeStampFormat": string,
    "dateFormat": string,
    "structureInFirstRow": string,
    "incremental": boolean,
    "fileStructure": string,
    "fieldDelimiterChar": string,
    "rowLimit": integer,
    "fileFormat": string
  },
    "shapingPipelines": [{
    "": object
  }],
    "targetOptions": {
    "hiveTable": string,
    "customHiveTableSuffix": string,
    "customHiveTablePrefix": string,
    "blobTruncationSize": integer,
    "folderId": string,
    "customTablePrefix": string,
    "assetId": string,
    "hiveTableSchemaCustomName": boolean,
    "clobTruncationSize": integer,
    "inputFormat": string,
    "hiveTableSchemaName": string,
    "specifyHiveTableSchema": boolean,
    "customFileSuffix": string,
    "customFilePrefix": string,
    "customTableSuffix": string,
    "createHiveTable": boolean,
    "existingTablesAction": string
  },
    "batchProfilingEnabled": boolean,
    "datasetOption": string,
    "sources": [{
    "id": string,
    "tables": [{
    "id": string,
    "name": string,
    "datasetId": string,
    "columns": [{
    "scale": integer,
    "precision": integer,
    "description": string,
    "name": string,
    "isNullable": boolean,
    "type": string
  }],
    "sourceIds": []
  }],
    "connection": {
    "port": integer,
    "region": string,
    "accessKey": string,
    "gateway": string,
    "bucket": string,
    "userid": string,
    "folderPath": string,
    "ssl": boolean,
    "refreshtoken": string,
    "projectId": string,
    "collection": string,
    "type": string,
    "password": string,
    "hiveSslEnabled": boolean,
    "schema": string,
    "id": string,
    "description": string,
    "loginUrl": string,
    "tenantid": string,
    "hivePassword": string,
    "serviceenvironment": string,
    "sid": string,
    "accesstoken": string,
    "host": string,
    "hivePort": integer,
    "authToken": string,
    "lastUpdated": string,
    "hiveHost": string,
    "hiveUser": string,
    "database": string,
    "sslCert": string,
    "hiveDb": string,
    "saveCredentials": boolean,
    "secretKey": string,
    "container": string,
    "authUrl": string,
    "connectionUrl": string,
    "lift": [],
    "server": string,
    "user": string
  }
  }],
    "targets": [{
    "id": string,
    "tables": [],
    "connection": object,
    "report": string,
    "ddl": string,
    "profile": boolean
  }]
  },
  "schedulesURL": string,
  "createdTimeStamp": string,
  "shortDescription": string,
  "lastModifiedTimeStamp": string,
  "createdTool": string,
  "name": string,
  "createdByServiceType": string,
  "URL": string,
  "isRunContinuously": boolean,
  "activityRunSummary": {
    "latestCompletionDate": string,
    "latestStatus": string,
    "runningFromScheduler": boolean,
    "running": boolean,
    "latestSubmitDate": string
  },
  "createdUser": string
}
Response model

200

Success

Body

docType

STRING , required

Used to identify activity documents

isSchedulable

BOOLEAN , required

If the Activity is Schedulable

activityScheduleSummary

object , required

The Activity Schedule Summary (Response only)

isPausable

BOOLEAN , required

If the Activity is Pausable

expirationDelay

STRING , required

The time (in hours) after which the activity will be automatically deleted from the system. Use the value 'never' to prevent the activity from expiring

isCancellable

BOOLEAN , required

If the Activity is Cancellable

isSuspendable

BOOLEAN , required

If the Activity is Suspendable

lastModifiedUser

STRING , required

The user that last modified the object (Response only)

version

STRING , required

The version of the activity schema being used

id

STRING , required

The ID of the object (Response only)

runsURL

STRING , required

The URL that can be used to get the list of runs for this activity (Response only)

inputDocument

object , required

The current Activity Input Document

schedulesURL

STRING , required

The URL that can be used to get the schedule for this activity (Response only)

createdTimeStamp

STRING , required

The timestamp when the object was created, in the format yyyy-MM-dd'T'HH:mm:ss.SSS (Response only)

shortDescription

STRING , required

The description of the object

lastModifiedTimeStamp

STRING , required

The timestamp when the object was last modified, in the format yyyy-MM-dd'T'HH:mm:ss.SSS (Response only)

createdTool

STRING , required

The tool used that created the object (Response only)

name

STRING , required

The object name

createdByServiceType

STRING , required

The service type that created the object (Response only)

URL

STRING , required

The URL that can be used to get the object (Response only)

isRunContinuously

BOOLEAN , required

If the Activity is to run continuously

activityRunSummary

object , required

The current Activity Run Summary (Response only)

createdUser

STRING , required

The user that created the object (Response only)

schedules

ARRAY , optional

Schedules for this Activity

id

STRING , required

The ID of this Schedule

startDate

STRING , required

The date this Schedule will start

invocationNextDate

STRING , required

The next Schedule invocation date

status

STRING , required

The status information for this Schedule

invocationCount

INTEGER , required

The number of times this Schedule has been invoked

scheduleURL

STRING , required

The URL of this Schedule

endDate

STRING , required

The date this Schedule will end

repeat

object , optional

The repeat information for this Schedule

interval

INTEGER , required

The interval at which the schedule should repeat

repeatWeeks

ARRAY , optional

The weeks of the month when the Activity is scheduled to run

type

STRING , required

The units used for the interval

repeatDays

ARRAY , optional

The days of the week when the Activity is scheduled to run

sourceOptions

object , optional

Options to apply to the activity source

shapingPipelines

ARRAY , optional

Shaping Pipelines

targetOptions

object , optional

Options to apply to the activity target

batchProfilingEnabled

BOOLEAN , required

Whether Batch Profiling is enabled or not

datasetOption

STRING , required

The action to perform for source/target datasets

sources

ARRAY , optional

A collection of source physical data resources

targets

ARRAY , optional

A collection of target physical data resources

nullValueHandling

STRING , required

Get the null value handling (Hadoop, Lift, S3, Swift, WebHDFS)

firstLineHeader

BOOLEAN , required

Indicates whether header information, such as column names, is specified in the first row of the file (Hadoop, Lift, S3, Swift, WebHDFS)

relatedTablesData

BOOLEAN , required

Whether to include data from related tables (DB2)

fieldDelimiter

STRING , required

Get the field delimiter (Hadoop, Lift, S3, Swift, WebHDFS)

customNullValueText

STRING , required

Get the custom null value text (Hadoop, Lift, S3, Swift, WebHDFS)

timeFormat

STRING , required

The time format. The default is %hh:%nn:%ss (Hadoop, Lift, S3, Swift, WebHDFS)

blobTruncationSize

INTEGER , required

The Blob Truncation Size (DB2)

rowDelimiter

STRING , required

Get the row delimiter (Hadoop, Lift, S3, Swift, WebHDFS)

readMode

STRING , required

Whether to read a single file or multiple files (S3)

codepage

INTEGER , required

Get the code page (Lift)

escapeTarget

STRING , required

Get the escape target (Hadoop)

clobTruncationSize

INTEGER , required

The Clob Truncation Size (DB2)

quoteCharacter

STRING , required

Get the quote character (Hadoop, Lift, S3, Swift, WebHDFS)

encoding

STRING , required

The file encoding, for example, UTF-8 (Hadoop, Lift, S3, Swift, WebHDFS)

nullValue

STRING , required

Get the null value (Hadoop, Lift, S3, Swift, WebHDFS)

timeStampFormat

STRING , required

The timestamp format. The default is %yyyy-%mm-%dd %hh:%nn:%ss (Hadoop, Lift, S3, Swift, WebHDFS)

dateFormat

STRING , required

The date format. The default is %yyyy-%mm-%dd (Hadoop, Lift, S3, Swift, WebHDFS)

structureInFirstRow

STRING , required

Indicates whether header information, such as column names, is specified in the first row of the file (Hadoop, Lift, S3, Swift, WebHDFS)

incremental

BOOLEAN , required

Whether the source data should be migrated incrementally (DB2, Lift, Netezza)

fileStructure

STRING , required

Get the file structure (Hadoop, Lift, S3, Swift, WebHDFS)

fieldDelimiterChar

STRING , required

Get the field delimiter char (Hadoop, Lift, S3, Swift, WebHDFS)

rowLimit

INTEGER , required

Get the row limit (DB2, Netezza)

fileFormat

STRING , required

Get the file format (Hadoop, Lift, S3, Swift, WebHDFS)

OBJECT , optional

Represents a shaping pipeline

hiveTable

STRING , required

The hive table name to use when writing data using the hive connection (WebHDFS)

customHiveTableSuffix

STRING , required

The custom Hive table suffix (Hadoop)

customHiveTablePrefix

STRING , required

The custom Hive table prefix (Hadoop)

blobTruncationSize

INTEGER , required

The Blob Truncation Size (Cloudant)

folderId

STRING , required

Parent Folder Id, typically a UUID (Watson Analytics)

customTablePrefix

STRING , required

A prefix to add to the names of target tables. This value applies when target table names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (RDBMS)

assetId

STRING , required

Asset Id, typically a UUID (Watson Analytics)

hiveTableSchemaCustomName

BOOLEAN , required

Custom name for the Hive table schema (Hadoop)

clobTruncationSize

INTEGER , required

The Clob Truncation Size (Cloudant)

inputFormat

STRING , required

The input format (Cloudant)

hiveTableSchemaName

STRING , required

The Hive table schema name (Hadoop)

specifyHiveTableSchema

BOOLEAN , required

Specify the Hive Table Schema (Hadoop)

customFileSuffix

STRING , required

A suffix to add to the names of target files. This value applies when target files names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (Cloudant, Swift)

customFilePrefix

STRING , required

A prefix to add to the names of target files. This value applies when target files names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (Cloudant, Swift)

customTableSuffix

STRING , required

A suffix to add to the names of target tables. This value applies when target table names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (RDBMS)

createHiveTable

BOOLEAN , required

Whether the hive table should be created or not (WebHDFS)

existingTablesAction

STRING , required

The action to perform when the target tables already exist (RDBMS)

id

STRING , required

The object Id

tables

ARRAY , optional

The collection of tables

connection

object , optional

The source connection

id

STRING , required

The object id

name

STRING , required

The object display name

datasetId

STRING , required

The dataset id referenced by this table (only applicable for target tables and only for v3.0 and later)

columns

ARRAY , optional

The table columns

sourceIds

ARRAY , optional

The source ids referenced by this table (only applicable for target tables and only for v2.7 and earlier. For v3.0 this is only supported as a legacy field)

scale

INTEGER , required

The column scale

precision

INTEGER , required

The column precision

description

STRING , required

The column description

name

STRING , required

The column name

isNullable

BOOLEAN , required

Whether the column is nullable

type

STRING , required

The column type

port

INTEGER , required

The connection port

region

STRING , required

The region for this connection

accessKey

STRING , required

The accessKey for this connection

gateway

STRING , required

The secure gateway for this connection

bucket

STRING , required

The bucket for this connection

userid

STRING , required

The user id (This is different to the user/username and is only required for Bluemix Object Storage currently)

folderPath

STRING , required

The folder path for this connection

ssl

BOOLEAN , required

Whether to use ssl for this connection

refreshtoken

STRING , required

The refresh token for this connection

projectId

STRING , required

The projectId for this connection

collection

STRING , required

The collection for this connection

type

STRING , required

The type of this connection

password

STRING , required

The connection password

hiveSslEnabled

BOOLEAN , required

Whether Hive SSL is enabled for this connection

schema

STRING , required

The connection database schema

id

STRING , required

The id of this connection

description

STRING , required

A description of this connection

loginUrl

STRING , required

The URL to use to access this connection

tenantid

STRING , required

The tenantid for a butterfly connection

hivePassword

STRING , required

The Hive Password to use for this connection

serviceenvironment

STRING , required

The datalake service environment of this connection

sid

STRING , required

The Oracle sid

accesstoken

STRING , required

The access token for this connection

host

STRING , required

The connection host

hivePort

INTEGER , required

The Hive Port to use for this connection

authToken

STRING , required

The auth token for this connection

lastUpdated

STRING , required

When the connection was last updated

hiveHost

STRING , required

The Hive Host to use for this connection

hiveUser

STRING , required

The Hive User to use for this connection

database

STRING , required

The connection database

sslCert

STRING , required

The self-signed SSL certificate of the database server must be specified in the PEM X.509 format. Only use this property if the ssl property is specified, set to true and if the database server uses an SSL certificate that is not signed by the known CA authority.

hiveDb

STRING , required

The Hive Database to use for this connection

saveCredentials

BOOLEAN , required

Whether to save the credentials for this connection

secretKey

STRING , required

The secret key for this connection

container

STRING , required

The container for this connection

authUrl

STRING , required

The auth url for this connection

connectionUrl

STRING , required

The URL to use to access this connection

lift

ARRAY , optional

The lift details of this connection

server

STRING , required

The server for this connection

user

STRING , required

The connection user

id

STRING , required

The object Id

tables

ARRAY , optional

The collection of tables

connection

OBJECT , optional

report

STRING , required

The DDL conversion report for use with Lift. (Lift only)

ddl

STRING , required

The DDL for use with Lift (Lift only)

profile

BOOLEAN , required

Whether the target should be profiled

latestCompletionDate

STRING , required

The latest run completion date

latestStatus

STRING , required

The most recent status of the activity run

runningFromScheduler

BOOLEAN , required

Whether this activity is running from the Scheduler or not

running

BOOLEAN , required

Whether this activity is currently running or not

latestSubmitDate

STRING , required

The latest run submission date

500

Internal Server Error

Body

httpStatus

INTEGER , required

The HTTP response status code

msgSeverity

STRING , required

Message severity

msgSourceCluster

STRING , required

Cluster member ID where the exception was generated (services tier only)

msgSessionId

STRING , required

The caller's session ID

msgExplanation

STRING , required

More detailed explanation of the error, including timestamp and internal diagnostics codes etc

msgExtra

OBJECT , required

The HTTP response status code

msgText

STRING , required

Short summary of the error, ie The activity is invalid as the table name property must be set

msgUserId

STRING , required

The caller's user ID

msgId

STRING , required

Message identifier. Can be any valid IBM SWG message prefix ID, ie CDIFL1234E

msgTimestamp

STRING , required

When the error occurred

msgTenantId

STRING , required

The caller's tenant ID

msgSourceComponent

STRING , required

Source component of the exception

msgResponse

STRING , required

What the user should do about the error (optional) - only provide this if you have a meaninful user action to correct the error

Response example

200

Success

								{
  "docType" : string,
  "isSchedulable" : boolean,
  "activityScheduleSummary" : {
    "schedules" : [{
    "id" : string,
    "startDate" : string,
    "invocationNextDate" : string,
    "status" : string,
    "invocationCount" : integer,
    "scheduleURL" : string,
    "endDate" : string,
    "repeat" : {
    "interval" : integer,
    "repeatWeeks" : [array],
    "type" : string,
    "repeatDays" : [array]
  }
  }]
  },
  "isPausable" : boolean,
  "expirationDelay" : string,
  "isCancellable" : boolean,
  "isSuspendable" : boolean,
  "lastModifiedUser" : string,
  "version" : string,
  "id" : string,
  "runsURL" : string,
  "inputDocument" : {
    "sourceOptions" : {
    "nullValueHandling" : string,
    "firstLineHeader" : boolean,
    "relatedTablesData" : boolean,
    "fieldDelimiter" : string,
    "customNullValueText" : string,
    "timeFormat" : string,
    "blobTruncationSize" : integer,
    "rowDelimiter" : string,
    "readMode" : string,
    "codepage" : integer,
    "escapeTarget" : string,
    "clobTruncationSize" : integer,
    "quoteCharacter" : string,
    "encoding" : string,
    "nullValue" : string,
    "timeStampFormat" : string,
    "dateFormat" : string,
    "structureInFirstRow" : string,
    "incremental" : boolean,
    "fileStructure" : string,
    "fieldDelimiterChar" : string,
    "rowLimit" : integer,
    "fileFormat" : string
  },
    "shapingPipelines" : [{
    "" : object
  }],
    "targetOptions" : {
    "hiveTable" : string,
    "customHiveTableSuffix" : string,
    "customHiveTablePrefix" : string,
    "blobTruncationSize" : integer,
    "folderId" : string,
    "customTablePrefix" : string,
    "assetId" : string,
    "hiveTableSchemaCustomName" : boolean,
    "clobTruncationSize" : integer,
    "inputFormat" : string,
    "hiveTableSchemaName" : string,
    "specifyHiveTableSchema" : boolean,
    "customFileSuffix" : string,
    "customFilePrefix" : string,
    "customTableSuffix" : string,
    "createHiveTable" : boolean,
    "existingTablesAction" : string
  },
    "batchProfilingEnabled" : boolean,
    "datasetOption" : string,
    "sources" : [{
    "id" : string,
    "tables" : [{
    "id" : string,
    "name" : string,
    "datasetId" : string,
    "columns" : [{
    "scale" : integer,
    "precision" : integer,
    "description" : string,
    "name" : string,
    "isNullable" : boolean,
    "type" : string
  }],
    "sourceIds" : [array]
  }],
    "connection" : {
    "port" : integer,
    "region" : string,
    "accessKey" : string,
    "gateway" : string,
    "bucket" : string,
    "userid" : string,
    "folderPath" : string,
    "ssl" : boolean,
    "refreshtoken" : string,
    "projectId" : string,
    "collection" : string,
    "type" : string,
    "password" : string,
    "hiveSslEnabled" : boolean,
    "schema" : string,
    "id" : string,
    "description" : string,
    "loginUrl" : string,
    "tenantid" : string,
    "hivePassword" : string,
    "serviceenvironment" : string,
    "sid" : string,
    "accesstoken" : string,
    "host" : string,
    "hivePort" : integer,
    "authToken" : string,
    "lastUpdated" : string,
    "hiveHost" : string,
    "hiveUser" : string,
    "database" : string,
    "sslCert" : string,
    "hiveDb" : string,
    "saveCredentials" : boolean,
    "secretKey" : string,
    "container" : string,
    "authUrl" : string,
    "connectionUrl" : string,
    "lift" : [array],
    "server" : string,
    "user" : string
  }
  }],
    "targets" : [{
    "id" : string,
    "tables" : [array],
    "connection" : object,
    "report" : string,
    "ddl" : string,
    "profile" : boolean
  }]
  },
  "schedulesURL" : string,
  "createdTimeStamp" : string,
  "shortDescription" : string,
  "lastModifiedTimeStamp" : string,
  "createdTool" : string,
  "name" : string,
  "createdByServiceType" : string,
  "URL" : string,
  "isRunContinuously" : boolean,
  "activityRunSummary" : {
    "latestCompletionDate" : string,
    "latestStatus" : string,
    "runningFromScheduler" : boolean,
    "running" : boolean,
    "latestSubmitDate" : string
  },
  "createdUser" : string
}
							

500

Internal Server Error

								{
  "httpStatus" : integer,
  "msgSeverity" : string,
  "msgSourceCluster" : string,
  "msgSessionId" : string,
  "msgExplanation" : string,
  "msgExtra" : object,
  "msgText" : string,
  "msgUserId" : string,
  "msgId" : string,
  "msgTimestamp" : string,
  "msgTenantId" : string,
  "msgSourceComponent" : string,
  "msgResponse" : string
}
							
Delete a list of Activities

DELETE   /v1

			https://service.binding.ur/ibm/dataworks/activities/v1
		
Keys
Path and Query parameters

id

ARRAY , optional

List of Activity IDs

Request code
								
HttpResponse<String> response = Unirest.delete("https://ibm.com/ibm/dataworks/activities/v1?id=undefined") .header("accept", "application/json;charset=utf-8") .asString();
Response model

200

Success

Body

404

Activity not found

Body

httpStatus

INTEGER , required

The HTTP response status code

msgSeverity

STRING , required

Message severity

msgSourceCluster

STRING , required

Cluster member ID where the exception was generated (services tier only)

msgSessionId

STRING , required

The caller's session ID

msgExplanation

STRING , required

More detailed explanation of the error, including timestamp and internal diagnostics codes etc

msgExtra

OBJECT , required

The HTTP response status code

msgText

STRING , required

Short summary of the error, ie The activity is invalid as the table name property must be set

msgUserId

STRING , required

The caller's user ID

msgId

STRING , required

Message identifier. Can be any valid IBM SWG message prefix ID, ie CDIFL1234E

msgTimestamp

STRING , required

When the error occurred

msgTenantId

STRING , required

The caller's tenant ID

msgSourceComponent

STRING , required

Source component of the exception

msgResponse

STRING , required

What the user should do about the error (optional) - only provide this if you have a meaninful user action to correct the error

500

Internal Server Error

Body

httpStatus

INTEGER , required

The HTTP response status code

msgSeverity

STRING , required

Message severity

msgSourceCluster

STRING , required

Cluster member ID where the exception was generated (services tier only)

msgSessionId

STRING , required

The caller's session ID

msgExplanation

STRING , required

More detailed explanation of the error, including timestamp and internal diagnostics codes etc

msgExtra

OBJECT , required

The HTTP response status code

msgText

STRING , required

Short summary of the error, ie The activity is invalid as the table name property must be set

msgUserId

STRING , required

The caller's user ID

msgId

STRING , required

Message identifier. Can be any valid IBM SWG message prefix ID, ie CDIFL1234E

msgTimestamp

STRING , required

When the error occurred

msgTenantId

STRING , required

The caller's tenant ID

msgSourceComponent

STRING , required

Source component of the exception

msgResponse

STRING , required

What the user should do about the error (optional) - only provide this if you have a meaninful user action to correct the error

Response example

200

Success

								
							

404

Activity not found

								{
  "httpStatus" : integer,
  "msgSeverity" : string,
  "msgSourceCluster" : string,
  "msgSessionId" : string,
  "msgExplanation" : string,
  "msgExtra" : object,
  "msgText" : string,
  "msgUserId" : string,
  "msgId" : string,
  "msgTimestamp" : string,
  "msgTenantId" : string,
  "msgSourceComponent" : string,
  "msgResponse" : string
}
							

500

Internal Server Error

								{
  "httpStatus" : integer,
  "msgSeverity" : string,
  "msgSourceCluster" : string,
  "msgSessionId" : string,
  "msgExplanation" : string,
  "msgExtra" : object,
  "msgText" : string,
  "msgUserId" : string,
  "msgId" : string,
  "msgTimestamp" : string,
  "msgTenantId" : string,
  "msgSourceComponent" : string,
  "msgResponse" : string
}
							
Delete an Activity by ID

DELETE   /v1/{id}

			https://service.binding.ur/ibm/dataworks/activities/v1/{id}
		
Keys
Path and Query parameters

id

URL , required

Activity ID

Request code
								
HttpResponse<String> response = Unirest.delete("https://ibm.com/ibm/dataworks/activities/v1/{id_string}") .header("accept", "application/json;charset=utf-8") .asString();
Response model

200

Success

Body

404

Activity not found

Body

httpStatus

INTEGER , required

The HTTP response status code

msgSeverity

STRING , required

Message severity

msgSourceCluster

STRING , required

Cluster member ID where the exception was generated (services tier only)

msgSessionId

STRING , required

The caller's session ID

msgExplanation

STRING , required

More detailed explanation of the error, including timestamp and internal diagnostics codes etc

msgExtra

OBJECT , required

The HTTP response status code

msgText

STRING , required

Short summary of the error, ie The activity is invalid as the table name property must be set

msgUserId

STRING , required

The caller's user ID

msgId

STRING , required

Message identifier. Can be any valid IBM SWG message prefix ID, ie CDIFL1234E

msgTimestamp

STRING , required

When the error occurred

msgTenantId

STRING , required

The caller's tenant ID

msgSourceComponent

STRING , required

Source component of the exception

msgResponse

STRING , required

What the user should do about the error (optional) - only provide this if you have a meaninful user action to correct the error

500

Internal Server Error

Body

httpStatus

INTEGER , required

The HTTP response status code

msgSeverity

STRING , required

Message severity

msgSourceCluster

STRING , required

Cluster member ID where the exception was generated (services tier only)

msgSessionId

STRING , required

The caller's session ID

msgExplanation

STRING , required

More detailed explanation of the error, including timestamp and internal diagnostics codes etc

msgExtra

OBJECT , required

The HTTP response status code

msgText

STRING , required

Short summary of the error, ie The activity is invalid as the table name property must be set

msgUserId

STRING , required

The caller's user ID

msgId

STRING , required

Message identifier. Can be any valid IBM SWG message prefix ID, ie CDIFL1234E

msgTimestamp

STRING , required

When the error occurred

msgTenantId

STRING , required

The caller's tenant ID

msgSourceComponent

STRING , required

Source component of the exception

msgResponse

STRING , required

What the user should do about the error (optional) - only provide this if you have a meaninful user action to correct the error

Response example

200

Success

								
							

404

Activity not found

								{
  "httpStatus" : integer,
  "msgSeverity" : string,
  "msgSourceCluster" : string,
  "msgSessionId" : string,
  "msgExplanation" : string,
  "msgExtra" : object,
  "msgText" : string,
  "msgUserId" : string,
  "msgId" : string,
  "msgTimestamp" : string,
  "msgTenantId" : string,
  "msgSourceComponent" : string,
  "msgResponse" : string
}
							

500

Internal Server Error

								{
  "httpStatus" : integer,
  "msgSeverity" : string,
  "msgSourceCluster" : string,
  "msgSessionId" : string,
  "msgExplanation" : string,
  "msgExtra" : object,
  "msgText" : string,
  "msgUserId" : string,
  "msgId" : string,
  "msgTimestamp" : string,
  "msgTenantId" : string,
  "msgSourceComponent" : string,
  "msgResponse" : string
}
							
Get Activity API version info

GET   /v1/version

			https://service.binding.ur/ibm/dataworks/activities/v1/version
		
Keys
Request code
								
HttpResponse<String> response = Unirest.get("https://ibm.com/ibm/dataworks/activities/v1/version") .header("accept", "application/json;charset=utf-8") .asString();
Response model

200

Success

Body

timestamp

STRING , required

The timestamp when the information was retrieved

status

STRING , required

The status indicating whether the version info is available

loadAPI_sparkBuildNumber

STRING , required

The Load API Spark Build Number

activityAPIVersion

STRING , required

The Activity API Version

pipelineAPIVersion

STRING , required

The Pipeline API Version

loadAPI_restBuildNumber

STRING , required

The Load API REST Build Number

500

Internal Server Error

Body

httpStatus

INTEGER , required

The HTTP response status code

msgSeverity

STRING , required

Message severity

msgSourceCluster

STRING , required

Cluster member ID where the exception was generated (services tier only)

msgSessionId

STRING , required

The caller's session ID

msgExplanation

STRING , required

More detailed explanation of the error, including timestamp and internal diagnostics codes etc

msgExtra

OBJECT , required

The HTTP response status code

msgText

STRING , required

Short summary of the error, ie The activity is invalid as the table name property must be set

msgUserId

STRING , required

The caller's user ID

msgId

STRING , required

Message identifier. Can be any valid IBM SWG message prefix ID, ie CDIFL1234E

msgTimestamp

STRING , required

When the error occurred

msgTenantId

STRING , required

The caller's tenant ID

msgSourceComponent

STRING , required

Source component of the exception

msgResponse

STRING , required

What the user should do about the error (optional) - only provide this if you have a meaninful user action to correct the error

Response example

200

Success

								{
  "timestamp" : string,
  "status" : string,
  "loadAPI_sparkBuildNumber" : string,
  "activityAPIVersion" : string,
  "pipelineAPIVersion" : string,
  "loadAPI_restBuildNumber" : string
}
							

500

Internal Server Error

								{
  "httpStatus" : integer,
  "msgSeverity" : string,
  "msgSourceCluster" : string,
  "msgSessionId" : string,
  "msgExplanation" : string,
  "msgExtra" : object,
  "msgText" : string,
  "msgUserId" : string,
  "msgId" : string,
  "msgTimestamp" : string,
  "msgTenantId" : string,
  "msgSourceComponent" : string,
  "msgResponse" : string
}
							
Get a List of Activities

GET   /v1

			https://service.binding.ur/ibm/dataworks/activities/v1
		
Keys
Path and Query parameters

filter

STRING , optional

JSON filter parameter

includeActivityRunSummary

BOOLEAN , optional

Include the Activity Run Summary

includeActivityScheduleSummary

BOOLEAN , optional

Include the Activity Schedule Summary

limit

STRING , optional

Paging limit

pageToken

STRING , optional

Paging token

sort

STRING , optional

Sort parameter

Request code
								
HttpResponse<String> response = Unirest.get("https://ibm.com/ibm/dataworks/activities/v1?filter={%22op%22%3A%22equals%22%2C%22data%22%3A%5B%20%20{%20%20%20%20%20%22op%22%3A%22string%22%2C%20%20%20%20%20%22data%22%3A%22name%22%2C%20%20%20%20%20%22isCol%22%3Atrue%20%20}%2C%20%20{%20%20%20%20%20%22op%22%3A%22string%22%2C%20%20%20%20%20%22data%22%3A%22activityName%22%2C%20%20%20%20%20%22isCol%22%3Afalse%20%20}%5D}&sort=(-name)&limit=5&pageToken=examplepagetoken123&includeActivityRunSummary=true&includeActivityScheduleSummary=true") .header("accept", "application/json;charset=utf-8") .asString();
Response model

200

Success

Body

docType

STRING , required

Used to identify activity documents

isSchedulable

BOOLEAN , required

If the Activity is Schedulable

activityScheduleSummary

object , required

The Activity Schedule Summary (Response only)

isPausable

BOOLEAN , required

If the Activity is Pausable

expirationDelay

STRING , required

The time (in hours) after which the activity will be automatically deleted from the system. Use the value 'never' to prevent the activity from expiring

isCancellable

BOOLEAN , required

If the Activity is Cancellable

isSuspendable

BOOLEAN , required

If the Activity is Suspendable

lastModifiedUser

STRING , required

The user that last modified the object (Response only)

version

STRING , required

The version of the activity schema being used

id

STRING , required

The ID of the object (Response only)

runsURL

STRING , required

The URL that can be used to get the list of runs for this activity (Response only)

inputDocument

object , required

The current Activity Input Document

schedulesURL

STRING , required

The URL that can be used to get the schedule for this activity (Response only)

createdTimeStamp

STRING , required

The timestamp when the object was created, in the format yyyy-MM-dd'T'HH:mm:ss.SSS (Response only)

shortDescription

STRING , required

The description of the object

lastModifiedTimeStamp

STRING , required

The timestamp when the object was last modified, in the format yyyy-MM-dd'T'HH:mm:ss.SSS (Response only)

createdTool

STRING , required

The tool used that created the object (Response only)

name

STRING , required

The object name

createdByServiceType

STRING , required

The service type that created the object (Response only)

URL

STRING , required

The URL that can be used to get the object (Response only)

isRunContinuously

BOOLEAN , required

If the Activity is to run continuously

activityRunSummary

object , required

The current Activity Run Summary (Response only)

createdUser

STRING , required

The user that created the object (Response only)

schedules

ARRAY , optional

Schedules for this Activity

id

STRING , required

The ID of this Schedule

startDate

STRING , required

The date this Schedule will start

invocationNextDate

STRING , required

The next Schedule invocation date

status

STRING , required

The status information for this Schedule

invocationCount

INTEGER , required

The number of times this Schedule has been invoked

scheduleURL

STRING , required

The URL of this Schedule

endDate

STRING , required

The date this Schedule will end

repeat

object , optional

The repeat information for this Schedule

interval

INTEGER , required

The interval at which the schedule should repeat

repeatWeeks

ARRAY , optional

The weeks of the month when the Activity is scheduled to run

type

STRING , required

The units used for the interval

repeatDays

ARRAY , optional

The days of the week when the Activity is scheduled to run

sourceOptions

object , optional

Options to apply to the activity source

shapingPipelines

ARRAY , optional

Shaping Pipelines

targetOptions

object , optional

Options to apply to the activity target

batchProfilingEnabled

BOOLEAN , required

Whether Batch Profiling is enabled or not

datasetOption

STRING , required

The action to perform for source/target datasets

sources

ARRAY , optional

A collection of source physical data resources

targets

ARRAY , optional

A collection of target physical data resources

nullValueHandling

STRING , required

Get the null value handling (Hadoop, Lift, S3, Swift, WebHDFS)

firstLineHeader

BOOLEAN , required

Indicates whether header information, such as column names, is specified in the first row of the file (Hadoop, Lift, S3, Swift, WebHDFS)

relatedTablesData

BOOLEAN , required

Whether to include data from related tables (DB2)

fieldDelimiter

STRING , required

Get the field delimiter (Hadoop, Lift, S3, Swift, WebHDFS)

customNullValueText

STRING , required

Get the custom null value text (Hadoop, Lift, S3, Swift, WebHDFS)

timeFormat

STRING , required

The time format. The default is %hh:%nn:%ss (Hadoop, Lift, S3, Swift, WebHDFS)

blobTruncationSize

INTEGER , required

The Blob Truncation Size (DB2)

rowDelimiter

STRING , required

Get the row delimiter (Hadoop, Lift, S3, Swift, WebHDFS)

readMode

STRING , required

Whether to read a single file or multiple files (S3)

codepage

INTEGER , required

Get the code page (Lift)

escapeTarget

STRING , required

Get the escape target (Hadoop)

clobTruncationSize

INTEGER , required

The Clob Truncation Size (DB2)

quoteCharacter

STRING , required

Get the quote character (Hadoop, Lift, S3, Swift, WebHDFS)

encoding

STRING , required

The file encoding, for example, UTF-8 (Hadoop, Lift, S3, Swift, WebHDFS)

nullValue

STRING , required

Get the null value (Hadoop, Lift, S3, Swift, WebHDFS)

timeStampFormat

STRING , required

The timestamp format. The default is %yyyy-%mm-%dd %hh:%nn:%ss (Hadoop, Lift, S3, Swift, WebHDFS)

dateFormat

STRING , required

The date format. The default is %yyyy-%mm-%dd (Hadoop, Lift, S3, Swift, WebHDFS)

structureInFirstRow

STRING , required

Indicates whether header information, such as column names, is specified in the first row of the file (Hadoop, Lift, S3, Swift, WebHDFS)

incremental

BOOLEAN , required

Whether the source data should be migrated incrementally (DB2, Lift, Netezza)

fileStructure

STRING , required

Get the file structure (Hadoop, Lift, S3, Swift, WebHDFS)

fieldDelimiterChar

STRING , required

Get the field delimiter char (Hadoop, Lift, S3, Swift, WebHDFS)

rowLimit

INTEGER , required

Get the row limit (DB2, Netezza)

fileFormat

STRING , required

Get the file format (Hadoop, Lift, S3, Swift, WebHDFS)

OBJECT , optional

Represents a shaping pipeline

hiveTable

STRING , required

The hive table name to use when writing data using the hive connection (WebHDFS)

customHiveTableSuffix

STRING , required

The custom Hive table suffix (Hadoop)

customHiveTablePrefix

STRING , required

The custom Hive table prefix (Hadoop)

blobTruncationSize

INTEGER , required

The Blob Truncation Size (Cloudant)

folderId

STRING , required

Parent Folder Id, typically a UUID (Watson Analytics)

customTablePrefix

STRING , required

A prefix to add to the names of target tables. This value applies when target table names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (RDBMS)

assetId

STRING , required

Asset Id, typically a UUID (Watson Analytics)

hiveTableSchemaCustomName

BOOLEAN , required

Custom name for the Hive table schema (Hadoop)

clobTruncationSize

INTEGER , required

The Clob Truncation Size (Cloudant)

inputFormat

STRING , required

The input format (Cloudant)

hiveTableSchemaName

STRING , required

The Hive table schema name (Hadoop)

specifyHiveTableSchema

BOOLEAN , required

Specify the Hive Table Schema (Hadoop)

customFileSuffix

STRING , required

A suffix to add to the names of target files. This value applies when target files names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (Cloudant, Swift)

customFilePrefix

STRING , required

A prefix to add to the names of target files. This value applies when target files names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (Cloudant, Swift)

customTableSuffix

STRING , required

A suffix to add to the names of target tables. This value applies when target table names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (RDBMS)

createHiveTable

BOOLEAN , required

Whether the hive table should be created or not (WebHDFS)

existingTablesAction

STRING , required

The action to perform when the target tables already exist (RDBMS)

id

STRING , required

The object Id

tables

ARRAY , optional

The collection of tables

connection

object , optional

The source connection

id

STRING , required

The object id

name

STRING , required

The object display name

datasetId

STRING , required

The dataset id referenced by this table (only applicable for target tables and only for v3.0 and later)

columns

ARRAY , optional

The table columns

sourceIds

ARRAY , optional

The source ids referenced by this table (only applicable for target tables and only for v2.7 and earlier. For v3.0 this is only supported as a legacy field)

scale

INTEGER , required

The column scale

precision

INTEGER , required

The column precision

description

STRING , required

The column description

name

STRING , required

The column name

isNullable

BOOLEAN , required

Whether the column is nullable

type

STRING , required

The column type

port

INTEGER , required

The connection port

region

STRING , required

The region for this connection

accessKey

STRING , required

The accessKey for this connection

gateway

STRING , required

The secure gateway for this connection

bucket

STRING , required

The bucket for this connection

userid

STRING , required

The user id (This is different to the user/username and is only required for Bluemix Object Storage currently)

folderPath

STRING , required

The folder path for this connection

ssl

BOOLEAN , required

Whether to use ssl for this connection

refreshtoken

STRING , required

The refresh token for this connection

projectId

STRING , required

The projectId for this connection

collection

STRING , required

The collection for this connection

type

STRING , required

The type of this connection

password

STRING , required

The connection password

hiveSslEnabled

BOOLEAN , required

Whether Hive SSL is enabled for this connection

schema

STRING , required

The connection database schema

id

STRING , required

The id of this connection

description

STRING , required

A description of this connection

loginUrl

STRING , required

The URL to use to access this connection

tenantid

STRING , required

The tenantid for a butterfly connection

hivePassword

STRING , required

The Hive Password to use for this connection

serviceenvironment

STRING , required

The datalake service environment of this connection

sid

STRING , required

The Oracle sid

accesstoken

STRING , required

The access token for this connection

host

STRING , required

The connection host

hivePort

INTEGER , required

The Hive Port to use for this connection

authToken

STRING , required

The auth token for this connection

lastUpdated

STRING , required

When the connection was last updated

hiveHost

STRING , required

The Hive Host to use for this connection

hiveUser

STRING , required

The Hive User to use for this connection

database

STRING , required

The connection database

sslCert

STRING , required

The self-signed SSL certificate of the database server must be specified in the PEM X.509 format. Only use this property if the ssl property is specified, set to true and if the database server uses an SSL certificate that is not signed by the known CA authority.

hiveDb

STRING , required

The Hive Database to use for this connection

saveCredentials

BOOLEAN , required

Whether to save the credentials for this connection

secretKey

STRING , required

The secret key for this connection

container

STRING , required

The container for this connection

authUrl

STRING , required

The auth url for this connection

connectionUrl

STRING , required

The URL to use to access this connection

lift

ARRAY , optional

The lift details of this connection

server

STRING , required

The server for this connection

user

STRING , required

The connection user

id

STRING , required

The object Id

tables

ARRAY , optional

The collection of tables

connection

OBJECT , optional

report

STRING , required

The DDL conversion report for use with Lift. (Lift only)

ddl

STRING , required

The DDL for use with Lift (Lift only)

profile

BOOLEAN , required

Whether the target should be profiled

latestCompletionDate

STRING , required

The latest run completion date

latestStatus

STRING , required

The most recent status of the activity run

runningFromScheduler

BOOLEAN , required

Whether this activity is running from the Scheduler or not

running

BOOLEAN , required

Whether this activity is currently running or not

latestSubmitDate

STRING , required

The latest run submission date

500

Internal Server Error

Body

httpStatus

INTEGER , required

The HTTP response status code

msgSeverity

STRING , required

Message severity

msgSourceCluster

STRING , required

Cluster member ID where the exception was generated (services tier only)

msgSessionId

STRING , required

The caller's session ID

msgExplanation

STRING , required

More detailed explanation of the error, including timestamp and internal diagnostics codes etc

msgExtra

OBJECT , required

The HTTP response status code

msgText

STRING , required

Short summary of the error, ie The activity is invalid as the table name property must be set

msgUserId

STRING , required

The caller's user ID

msgId

STRING , required

Message identifier. Can be any valid IBM SWG message prefix ID, ie CDIFL1234E

msgTimestamp

STRING , required

When the error occurred

msgTenantId

STRING , required

The caller's tenant ID

msgSourceComponent

STRING , required

Source component of the exception

msgResponse

STRING , required

What the user should do about the error (optional) - only provide this if you have a meaninful user action to correct the error

Response example

200

Success

								{
  "docType" : string,
  "isSchedulable" : boolean,
  "activityScheduleSummary" : {
    "schedules" : [{
    "id" : string,
    "startDate" : string,
    "invocationNextDate" : string,
    "status" : string,
    "invocationCount" : integer,
    "scheduleURL" : string,
    "endDate" : string,
    "repeat" : {
    "interval" : integer,
    "repeatWeeks" : [array],
    "type" : string,
    "repeatDays" : [array]
  }
  }]
  },
  "isPausable" : boolean,
  "expirationDelay" : string,
  "isCancellable" : boolean,
  "isSuspendable" : boolean,
  "lastModifiedUser" : string,
  "version" : string,
  "id" : string,
  "runsURL" : string,
  "inputDocument" : {
    "sourceOptions" : {
    "nullValueHandling" : string,
    "firstLineHeader" : boolean,
    "relatedTablesData" : boolean,
    "fieldDelimiter" : string,
    "customNullValueText" : string,
    "timeFormat" : string,
    "blobTruncationSize" : integer,
    "rowDelimiter" : string,
    "readMode" : string,
    "codepage" : integer,
    "escapeTarget" : string,
    "clobTruncationSize" : integer,
    "quoteCharacter" : string,
    "encoding" : string,
    "nullValue" : string,
    "timeStampFormat" : string,
    "dateFormat" : string,
    "structureInFirstRow" : string,
    "incremental" : boolean,
    "fileStructure" : string,
    "fieldDelimiterChar" : string,
    "rowLimit" : integer,
    "fileFormat" : string
  },
    "shapingPipelines" : [{
    "" : object
  }],
    "targetOptions" : {
    "hiveTable" : string,
    "customHiveTableSuffix" : string,
    "customHiveTablePrefix" : string,
    "blobTruncationSize" : integer,
    "folderId" : string,
    "customTablePrefix" : string,
    "assetId" : string,
    "hiveTableSchemaCustomName" : boolean,
    "clobTruncationSize" : integer,
    "inputFormat" : string,
    "hiveTableSchemaName" : string,
    "specifyHiveTableSchema" : boolean,
    "customFileSuffix" : string,
    "customFilePrefix" : string,
    "customTableSuffix" : string,
    "createHiveTable" : boolean,
    "existingTablesAction" : string
  },
    "batchProfilingEnabled" : boolean,
    "datasetOption" : string,
    "sources" : [{
    "id" : string,
    "tables" : [{
    "id" : string,
    "name" : string,
    "datasetId" : string,
    "columns" : [{
    "scale" : integer,
    "precision" : integer,
    "description" : string,
    "name" : string,
    "isNullable" : boolean,
    "type" : string
  }],
    "sourceIds" : [array]
  }],
    "connection" : {
    "port" : integer,
    "region" : string,
    "accessKey" : string,
    "gateway" : string,
    "bucket" : string,
    "userid" : string,
    "folderPath" : string,
    "ssl" : boolean,
    "refreshtoken" : string,
    "projectId" : string,
    "collection" : string,
    "type" : string,
    "password" : string,
    "hiveSslEnabled" : boolean,
    "schema" : string,
    "id" : string,
    "description" : string,
    "loginUrl" : string,
    "tenantid" : string,
    "hivePassword" : string,
    "serviceenvironment" : string,
    "sid" : string,
    "accesstoken" : string,
    "host" : string,
    "hivePort" : integer,
    "authToken" : string,
    "lastUpdated" : string,
    "hiveHost" : string,
    "hiveUser" : string,
    "database" : string,
    "sslCert" : string,
    "hiveDb" : string,
    "saveCredentials" : boolean,
    "secretKey" : string,
    "container" : string,
    "authUrl" : string,
    "connectionUrl" : string,
    "lift" : [array],
    "server" : string,
    "user" : string
  }
  }],
    "targets" : [{
    "id" : string,
    "tables" : [array],
    "connection" : object,
    "report" : string,
    "ddl" : string,
    "profile" : boolean
  }]
  },
  "schedulesURL" : string,
  "createdTimeStamp" : string,
  "shortDescription" : string,
  "lastModifiedTimeStamp" : string,
  "createdTool" : string,
  "name" : string,
  "createdByServiceType" : string,
  "URL" : string,
  "isRunContinuously" : boolean,
  "activityRunSummary" : {
    "latestCompletionDate" : string,
    "latestStatus" : string,
    "runningFromScheduler" : boolean,
    "running" : boolean,
    "latestSubmitDate" : string
  },
  "createdUser" : string
}
							

500

Internal Server Error

								{
  "httpStatus" : integer,
  "msgSeverity" : string,
  "msgSourceCluster" : string,
  "msgSessionId" : string,
  "msgExplanation" : string,
  "msgExtra" : object,
  "msgText" : string,
  "msgUserId" : string,
  "msgId" : string,
  "msgTimestamp" : string,
  "msgTenantId" : string,
  "msgSourceComponent" : string,
  "msgResponse" : string
}
							
Get an Activity by ID

GET   /v1/{id}

			https://service.binding.ur/ibm/dataworks/activities/v1/{id}
		
Keys
Path and Query parameters

id

URL , required

Activity ID

Request code
								
HttpResponse<String> response = Unirest.get("https://ibm.com/ibm/dataworks/activities/v1/{id_string}") .header("accept", "application/json;charset=utf-8") .asString();
Response model

200

Success

Body

docType

STRING , required

Used to identify activity documents

isSchedulable

BOOLEAN , required

If the Activity is Schedulable

activityScheduleSummary

object , required

The Activity Schedule Summary (Response only)

isPausable

BOOLEAN , required

If the Activity is Pausable

expirationDelay

STRING , required

The time (in hours) after which the activity will be automatically deleted from the system. Use the value 'never' to prevent the activity from expiring

isCancellable

BOOLEAN , required

If the Activity is Cancellable

isSuspendable

BOOLEAN , required

If the Activity is Suspendable

lastModifiedUser

STRING , required

The user that last modified the object (Response only)

version

STRING , required

The version of the activity schema being used

id

STRING , required

The ID of the object (Response only)

runsURL

STRING , required

The URL that can be used to get the list of runs for this activity (Response only)

inputDocument

object , required

The current Activity Input Document

schedulesURL

STRING , required

The URL that can be used to get the schedule for this activity (Response only)

createdTimeStamp

STRING , required

The timestamp when the object was created, in the format yyyy-MM-dd'T'HH:mm:ss.SSS (Response only)

shortDescription

STRING , required

The description of the object

lastModifiedTimeStamp

STRING , required

The timestamp when the object was last modified, in the format yyyy-MM-dd'T'HH:mm:ss.SSS (Response only)

createdTool

STRING , required

The tool used that created the object (Response only)

name

STRING , required

The object name

createdByServiceType

STRING , required

The service type that created the object (Response only)

URL

STRING , required

The URL that can be used to get the object (Response only)

isRunContinuously

BOOLEAN , required

If the Activity is to run continuously

activityRunSummary

object , required

The current Activity Run Summary (Response only)

createdUser

STRING , required

The user that created the object (Response only)

schedules

ARRAY , optional

Schedules for this Activity

id

STRING , required

The ID of this Schedule

startDate

STRING , required

The date this Schedule will start

invocationNextDate

STRING , required

The next Schedule invocation date

status

STRING , required

The status information for this Schedule

invocationCount

INTEGER , required

The number of times this Schedule has been invoked

scheduleURL

STRING , required

The URL of this Schedule

endDate

STRING , required

The date this Schedule will end

repeat

object , optional

The repeat information for this Schedule

interval

INTEGER , required

The interval at which the schedule should repeat

repeatWeeks

ARRAY , optional

The weeks of the month when the Activity is scheduled to run

type

STRING , required

The units used for the interval

repeatDays

ARRAY , optional

The days of the week when the Activity is scheduled to run

sourceOptions

object , optional

Options to apply to the activity source

shapingPipelines

ARRAY , optional

Shaping Pipelines

targetOptions

object , optional

Options to apply to the activity target

batchProfilingEnabled

BOOLEAN , required

Whether Batch Profiling is enabled or not

datasetOption

STRING , required

The action to perform for source/target datasets

sources

ARRAY , optional

A collection of source physical data resources

targets

ARRAY , optional

A collection of target physical data resources

nullValueHandling

STRING , required

Get the null value handling (Hadoop, Lift, S3, Swift, WebHDFS)

firstLineHeader

BOOLEAN , required

Indicates whether header information, such as column names, is specified in the first row of the file (Hadoop, Lift, S3, Swift, WebHDFS)

relatedTablesData

BOOLEAN , required

Whether to include data from related tables (DB2)

fieldDelimiter

STRING , required

Get the field delimiter (Hadoop, Lift, S3, Swift, WebHDFS)

customNullValueText

STRING , required

Get the custom null value text (Hadoop, Lift, S3, Swift, WebHDFS)

timeFormat

STRING , required

The time format. The default is %hh:%nn:%ss (Hadoop, Lift, S3, Swift, WebHDFS)

blobTruncationSize

INTEGER , required

The Blob Truncation Size (DB2)

rowDelimiter

STRING , required

Get the row delimiter (Hadoop, Lift, S3, Swift, WebHDFS)

readMode

STRING , required

Whether to read a single file or multiple files (S3)

codepage

INTEGER , required

Get the code page (Lift)

escapeTarget

STRING , required

Get the escape target (Hadoop)

clobTruncationSize

INTEGER , required

The Clob Truncation Size (DB2)

quoteCharacter

STRING , required

Get the quote character (Hadoop, Lift, S3, Swift, WebHDFS)

encoding

STRING , required

The file encoding, for example, UTF-8 (Hadoop, Lift, S3, Swift, WebHDFS)

nullValue

STRING , required

Get the null value (Hadoop, Lift, S3, Swift, WebHDFS)

timeStampFormat

STRING , required

The timestamp format. The default is %yyyy-%mm-%dd %hh:%nn:%ss (Hadoop, Lift, S3, Swift, WebHDFS)

dateFormat

STRING , required

The date format. The default is %yyyy-%mm-%dd (Hadoop, Lift, S3, Swift, WebHDFS)

structureInFirstRow

STRING , required

Indicates whether header information, such as column names, is specified in the first row of the file (Hadoop, Lift, S3, Swift, WebHDFS)

incremental

BOOLEAN , required

Whether the source data should be migrated incrementally (DB2, Lift, Netezza)

fileStructure

STRING , required

Get the file structure (Hadoop, Lift, S3, Swift, WebHDFS)

fieldDelimiterChar

STRING , required

Get the field delimiter char (Hadoop, Lift, S3, Swift, WebHDFS)

rowLimit

INTEGER , required

Get the row limit (DB2, Netezza)

fileFormat

STRING , required

Get the file format (Hadoop, Lift, S3, Swift, WebHDFS)

OBJECT , optional

Represents a shaping pipeline

hiveTable

STRING , required

The hive table name to use when writing data using the hive connection (WebHDFS)

customHiveTableSuffix

STRING , required

The custom Hive table suffix (Hadoop)

customHiveTablePrefix

STRING , required

The custom Hive table prefix (Hadoop)

blobTruncationSize

INTEGER , required

The Blob Truncation Size (Cloudant)

folderId

STRING , required

Parent Folder Id, typically a UUID (Watson Analytics)

customTablePrefix

STRING , required

A prefix to add to the names of target tables. This value applies when target table names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (RDBMS)

assetId

STRING , required

Asset Id, typically a UUID (Watson Analytics)

hiveTableSchemaCustomName

BOOLEAN , required

Custom name for the Hive table schema (Hadoop)

clobTruncationSize

INTEGER , required

The Clob Truncation Size (Cloudant)

inputFormat

STRING , required

The input format (Cloudant)

hiveTableSchemaName

STRING , required

The Hive table schema name (Hadoop)

specifyHiveTableSchema

BOOLEAN , required

Specify the Hive Table Schema (Hadoop)

customFileSuffix

STRING , required

A suffix to add to the names of target files. This value applies when target files names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (Cloudant, Swift)

customFilePrefix

STRING , required

A prefix to add to the names of target files. This value applies when target files names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (Cloudant, Swift)

customTableSuffix

STRING , required

A suffix to add to the names of target tables. This value applies when target table names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (RDBMS)

createHiveTable

BOOLEAN , required

Whether the hive table should be created or not (WebHDFS)

existingTablesAction

STRING , required

The action to perform when the target tables already exist (RDBMS)

id

STRING , required

The object Id

tables

ARRAY , optional

The collection of tables

connection

object , optional

The source connection

id

STRING , required

The object id

name

STRING , required

The object display name

datasetId

STRING , required

The dataset id referenced by this table (only applicable for target tables and only for v3.0 and later)

columns

ARRAY , optional

The table columns

sourceIds

ARRAY , optional

The source ids referenced by this table (only applicable for target tables and only for v2.7 and earlier. For v3.0 this is only supported as a legacy field)

scale

INTEGER , required

The column scale

precision

INTEGER , required

The column precision

description

STRING , required

The column description

name

STRING , required

The column name

isNullable

BOOLEAN , required

Whether the column is nullable

type

STRING , required

The column type

port

INTEGER , required

The connection port

region

STRING , required

The region for this connection

accessKey

STRING , required

The accessKey for this connection

gateway

STRING , required

The secure gateway for this connection

bucket

STRING , required

The bucket for this connection

userid

STRING , required

The user id (This is different to the user/username and is only required for Bluemix Object Storage currently)

folderPath

STRING , required

The folder path for this connection

ssl

BOOLEAN , required

Whether to use ssl for this connection

refreshtoken

STRING , required

The refresh token for this connection

projectId

STRING , required

The projectId for this connection

collection

STRING , required

The collection for this connection

type

STRING , required

The type of this connection

password

STRING , required

The connection password

hiveSslEnabled

BOOLEAN , required

Whether Hive SSL is enabled for this connection

schema

STRING , required

The connection database schema

id

STRING , required

The id of this connection

description

STRING , required

A description of this connection

loginUrl

STRING , required

The URL to use to access this connection

tenantid

STRING , required

The tenantid for a butterfly connection

hivePassword

STRING , required

The Hive Password to use for this connection

serviceenvironment

STRING , required

The datalake service environment of this connection

sid

STRING , required

The Oracle sid

accesstoken

STRING , required

The access token for this connection

host

STRING , required

The connection host

hivePort

INTEGER , required

The Hive Port to use for this connection

authToken

STRING , required

The auth token for this connection

lastUpdated

STRING , required

When the connection was last updated

hiveHost

STRING , required

The Hive Host to use for this connection

hiveUser

STRING , required

The Hive User to use for this connection

database

STRING , required

The connection database

sslCert

STRING , required

The self-signed SSL certificate of the database server must be specified in the PEM X.509 format. Only use this property if the ssl property is specified, set to true and if the database server uses an SSL certificate that is not signed by the known CA authority.

hiveDb

STRING , required

The Hive Database to use for this connection

saveCredentials

BOOLEAN , required

Whether to save the credentials for this connection

secretKey

STRING , required

The secret key for this connection

container

STRING , required

The container for this connection

authUrl

STRING , required

The auth url for this connection

connectionUrl

STRING , required

The URL to use to access this connection

lift

ARRAY , optional

The lift details of this connection

server

STRING , required

The server for this connection

user

STRING , required

The connection user

id

STRING , required

The object Id

tables

ARRAY , optional

The collection of tables

connection

OBJECT , optional

report

STRING , required

The DDL conversion report for use with Lift. (Lift only)

ddl

STRING , required

The DDL for use with Lift (Lift only)

profile

BOOLEAN , required

Whether the target should be profiled

latestCompletionDate

STRING , required

The latest run completion date

latestStatus

STRING , required

The most recent status of the activity run

runningFromScheduler

BOOLEAN , required

Whether this activity is running from the Scheduler or not

running

BOOLEAN , required

Whether this activity is currently running or not

latestSubmitDate

STRING , required

The latest run submission date

404

Activity not found

Body

httpStatus

INTEGER , required

The HTTP response status code

msgSeverity

STRING , required

Message severity

msgSourceCluster

STRING , required

Cluster member ID where the exception was generated (services tier only)

msgSessionId

STRING , required

The caller's session ID

msgExplanation

STRING , required

More detailed explanation of the error, including timestamp and internal diagnostics codes etc

msgExtra

OBJECT , required

The HTTP response status code

msgText

STRING , required

Short summary of the error, ie The activity is invalid as the table name property must be set

msgUserId

STRING , required

The caller's user ID

msgId

STRING , required

Message identifier. Can be any valid IBM SWG message prefix ID, ie CDIFL1234E

msgTimestamp

STRING , required

When the error occurred

msgTenantId

STRING , required

The caller's tenant ID

msgSourceComponent

STRING , required

Source component of the exception

msgResponse

STRING , required

What the user should do about the error (optional) - only provide this if you have a meaninful user action to correct the error

500

Internal Server Error

Body

httpStatus

INTEGER , required

The HTTP response status code

msgSeverity

STRING , required

Message severity

msgSourceCluster

STRING , required

Cluster member ID where the exception was generated (services tier only)

msgSessionId

STRING , required

The caller's session ID

msgExplanation

STRING , required

More detailed explanation of the error, including timestamp and internal diagnostics codes etc

msgExtra

OBJECT , required

The HTTP response status code

msgText

STRING , required

Short summary of the error, ie The activity is invalid as the table name property must be set

msgUserId

STRING , required

The caller's user ID

msgId

STRING , required

Message identifier. Can be any valid IBM SWG message prefix ID, ie CDIFL1234E

msgTimestamp

STRING , required

When the error occurred

msgTenantId

STRING , required

The caller's tenant ID

msgSourceComponent

STRING , required

Source component of the exception

msgResponse

STRING , required

What the user should do about the error (optional) - only provide this if you have a meaninful user action to correct the error

Response example

200

Success

								{
  "docType" : string,
  "isSchedulable" : boolean,
  "activityScheduleSummary" : {
    "schedules" : [{
    "id" : string,
    "startDate" : string,
    "invocationNextDate" : string,
    "status" : string,
    "invocationCount" : integer,
    "scheduleURL" : string,
    "endDate" : string,
    "repeat" : {
    "interval" : integer,
    "repeatWeeks" : [array],
    "type" : string,
    "repeatDays" : [array]
  }
  }]
  },
  "isPausable" : boolean,
  "expirationDelay" : string,
  "isCancellable" : boolean,
  "isSuspendable" : boolean,
  "lastModifiedUser" : string,
  "version" : string,
  "id" : string,
  "runsURL" : string,
  "inputDocument" : {
    "sourceOptions" : {
    "nullValueHandling" : string,
    "firstLineHeader" : boolean,
    "relatedTablesData" : boolean,
    "fieldDelimiter" : string,
    "customNullValueText" : string,
    "timeFormat" : string,
    "blobTruncationSize" : integer,
    "rowDelimiter" : string,
    "readMode" : string,
    "codepage" : integer,
    "escapeTarget" : string,
    "clobTruncationSize" : integer,
    "quoteCharacter" : string,
    "encoding" : string,
    "nullValue" : string,
    "timeStampFormat" : string,
    "dateFormat" : string,
    "structureInFirstRow" : string,
    "incremental" : boolean,
    "fileStructure" : string,
    "fieldDelimiterChar" : string,
    "rowLimit" : integer,
    "fileFormat" : string
  },
    "shapingPipelines" : [{
    "" : object
  }],
    "targetOptions" : {
    "hiveTable" : string,
    "customHiveTableSuffix" : string,
    "customHiveTablePrefix" : string,
    "blobTruncationSize" : integer,
    "folderId" : string,
    "customTablePrefix" : string,
    "assetId" : string,
    "hiveTableSchemaCustomName" : boolean,
    "clobTruncationSize" : integer,
    "inputFormat" : string,
    "hiveTableSchemaName" : string,
    "specifyHiveTableSchema" : boolean,
    "customFileSuffix" : string,
    "customFilePrefix" : string,
    "customTableSuffix" : string,
    "createHiveTable" : boolean,
    "existingTablesAction" : string
  },
    "batchProfilingEnabled" : boolean,
    "datasetOption" : string,
    "sources" : [{
    "id" : string,
    "tables" : [{
    "id" : string,
    "name" : string,
    "datasetId" : string,
    "columns" : [{
    "scale" : integer,
    "precision" : integer,
    "description" : string,
    "name" : string,
    "isNullable" : boolean,
    "type" : string
  }],
    "sourceIds" : [array]
  }],
    "connection" : {
    "port" : integer,
    "region" : string,
    "accessKey" : string,
    "gateway" : string,
    "bucket" : string,
    "userid" : string,
    "folderPath" : string,
    "ssl" : boolean,
    "refreshtoken" : string,
    "projectId" : string,
    "collection" : string,
    "type" : string,
    "password" : string,
    "hiveSslEnabled" : boolean,
    "schema" : string,
    "id" : string,
    "description" : string,
    "loginUrl" : string,
    "tenantid" : string,
    "hivePassword" : string,
    "serviceenvironment" : string,
    "sid" : string,
    "accesstoken" : string,
    "host" : string,
    "hivePort" : integer,
    "authToken" : string,
    "lastUpdated" : string,
    "hiveHost" : string,
    "hiveUser" : string,
    "database" : string,
    "sslCert" : string,
    "hiveDb" : string,
    "saveCredentials" : boolean,
    "secretKey" : string,
    "container" : string,
    "authUrl" : string,
    "connectionUrl" : string,
    "lift" : [array],
    "server" : string,
    "user" : string
  }
  }],
    "targets" : [{
    "id" : string,
    "tables" : [array],
    "connection" : object,
    "report" : string,
    "ddl" : string,
    "profile" : boolean
  }]
  },
  "schedulesURL" : string,
  "createdTimeStamp" : string,
  "shortDescription" : string,
  "lastModifiedTimeStamp" : string,
  "createdTool" : string,
  "name" : string,
  "createdByServiceType" : string,
  "URL" : string,
  "isRunContinuously" : boolean,
  "activityRunSummary" : {
    "latestCompletionDate" : string,
    "latestStatus" : string,
    "runningFromScheduler" : boolean,
    "running" : boolean,
    "latestSubmitDate" : string
  },
  "createdUser" : string
}
							

404

Activity not found

								{
  "httpStatus" : integer,
  "msgSeverity" : string,
  "msgSourceCluster" : string,
  "msgSessionId" : string,
  "msgExplanation" : string,
  "msgExtra" : object,
  "msgText" : string,
  "msgUserId" : string,
  "msgId" : string,
  "msgTimestamp" : string,
  "msgTenantId" : string,
  "msgSourceComponent" : string,
  "msgResponse" : string
}
							

500

Internal Server Error

								{
  "httpStatus" : integer,
  "msgSeverity" : string,
  "msgSourceCluster" : string,
  "msgSessionId" : string,
  "msgExplanation" : string,
  "msgExtra" : object,
  "msgText" : string,
  "msgUserId" : string,
  "msgId" : string,
  "msgTimestamp" : string,
  "msgTenantId" : string,
  "msgSourceComponent" : string,
  "msgResponse" : string
}
							
Update an Activity

PUT   /v1/{id}

			https://service.binding.ur/ibm/dataworks/activities/v1/{id}
		
Keys
Path and Query parameters

id

URL , required

Activity ID to update

Request code
								
HttpResponse<String> response = Unirest.put("https://ibm.com/ibm/dataworks/activities/v1/{id_string}") .header("accept", "application/json;charset=utf-8") .header("content-type", "application/json;charset=utf-8") .body("{\"docType\":\"string\",\"isSchedulable\":true,\"activityScheduleSummary\":{\"description\":\"The Activity Schedule Summary (Response only)\",\"xml\":{\"name\":\"activityScheduleSummary\"},\"properties\":{\"schedules\":[{\"id\":\"string\",\"startDate\":\"string\",\"invocationNextDate\":\"string\",\"status\":\"string\",\"invocationCount\":0,\"scheduleURL\":\"string\",\"endDate\":\"string\",\"repeat\":{\"description\":\"The repeat information for this Schedule\",\"xml\":{\"name\":\"activityScheduleSummaryRepeat\"},\"properties\":{\"interval\":0,\"repeatWeeks\":[null],\"type\":\"string\",\"repeatDays\":[null]},\"type\":\"object\"}}]},\"type\":\"object\"},\"isPausable\":true,\"expirationDelay\":\"string\",\"isCancellable\":true,\"isSuspendable\":true,\"lastModifiedUser\":\"string\",\"version\":\"string\",\"id\":\"string\",\"runsURL\":\"string\",\"inputDocument\":{\"description\":\"The current Activity Input Document\",\"xml\":{\"name\":\"inputDocument\"},\"properties\":{\"sourceOptions\":{\"description\":\"Options to apply to the activity source\",\"xml\":{\"name\":\"sourceOptions\"},\"properties\":{\"nullValueHandling\":\"string\",\"firstLineHeader\":true,\"relatedTablesData\":true,\"fieldDelimiter\":\"string\",\"customNullValueText\":\"string\",\"timeFormat\":\"%hh:%nn:%ss\",\"blobTruncationSize\":0,\"rowDelimiter\":\"string\",\"readMode\":\"string\",\"codepage\":0,\"escapeTarget\":\"string\",\"clobTruncationSize\":0,\"quoteCharacter\":\"string\",\"encoding\":\"UTF-8\",\"nullValue\":\"string\",\"timeStampFormat\":\"%yyyy-%mm-%dd %hh:%nn:%ss\",\"dateFormat\":\"%yyyy-%mm-%dd\",\"structureInFirstRow\":\"string\",\"incremental\":true,\"fileStructure\":\"string\",\"fieldDelimiterChar\":\"string\",\"rowLimit\":0,\"fileFormat\":\"string\"},\"type\":\"object\"},\"shapingPipelines\":[null],\"targetOptions\":{\"description\":\"Options to apply to the activity target\",\"xml\":{\"name\":\"targetOptions\"},\"properties\":{\"hiveTable\":\"string\",\"customHiveTableSuffix\":\"string\",\"customHiveTablePrefix\":\"string\",\"blobTruncationSize\":0,\"folderId\":\"string\",\"customTablePrefix\":\"string\",\"assetId\":\"string\",\"hiveTableSchemaCustomName\":true,\"clobTruncationSize\":0,\"inputFormat\":\"string\",\"hiveTableSchemaName\":\"string\",\"specifyHiveTableSchema\":true,\"customFileSuffix\":\"string\",\"customFilePrefix\":\"string\",\"customTableSuffix\":\"string\",\"createHiveTable\":true,\"existingTablesAction\":\"string\"},\"type\":\"object\"},\"batchProfilingEnabled\":true,\"datasetOption\":\"string\",\"sources\":[{\"id\":\"string\",\"tables\":[{\"id\":\"string\",\"name\":\"string\",\"datasetId\":\"string\",\"columns\":[{\"scale\":0,\"precision\":0,\"description\":\"string\",\"name\":\"string\",\"isNullable\":true,\"type\":\"string\"}],\"sourceIds\":[null]}],\"connection\":{\"description\":\"The source connection\",\"xml\":{\"name\":\"connection\"},\"properties\":{\"port\":0,\"region\":\"string\",\"accessKey\":\"string\",\"gateway\":\"string\",\"bucket\":\"string\",\"userid\":\"string\",\"folderPath\":\"string\",\"ssl\":true,\"refreshtoken\":\"string\",\"projectId\":\"string\",\"collection\":\"string\",\"type\":\"string\",\"password\":\"string\",\"hiveSslEnabled\":true,\"schema\":\"string\",\"id\":\"string\",\"description\":\"string\",\"loginUrl\":\"string\",\"tenantid\":\"string\",\"hivePassword\":\"string\",\"serviceenvironment\":\"string\",\"sid\":\"string\",\"accesstoken\":\"string\",\"host\":\"string\",\"hivePort\":0,\"authToken\":\"string\",\"lastUpdated\":\"string\",\"hiveHost\":\"string\",\"hiveUser\":\"string\",\"database\":\"string\",\"sslCert\":\"string\",\"hiveDb\":\"string\",\"saveCredentials\":true,\"secretKey\":\"string\",\"container\":\"string\",\"authUrl\":\"string\",\"connectionUrl\":\"string\",\"lift\":[null],\"server\":\"string\",\"user\":\"string\"},\"type\":\"object\"}}],\"targets\":[{\"id\":\"string\",\"tables\":[{\"id\":\"string\",\"name\":\"string\",\"datasetId\":\"string\",\"columns\":[{\"scale\":0,\"precision\":0,\"description\":\"string\",\"name\":\"string\",\"isNullable\":true,\"type\":\"string\"}],\"sourceIds\":[null]}],\"connection\":{\"description\":\"The target connection\",\"xml\":{\"name\":\"connection\"},\"properties\":{\"port\":0,\"region\":\"string\",\"accessKey\":\"string\",\"gateway\":\"string\",\"bucket\":\"string\",\"userid\":\"string\",\"folderPath\":\"string\",\"ssl\":true,\"refreshtoken\":\"string\",\"projectId\":\"string\",\"collection\":\"string\",\"type\":\"string\",\"password\":\"string\",\"hiveSslEnabled\":true,\"schema\":\"string\",\"id\":\"string\",\"description\":\"string\",\"loginUrl\":\"string\",\"tenantid\":\"string\",\"hivePassword\":\"string\",\"serviceenvironment\":\"string\",\"sid\":\"string\",\"accesstoken\":\"string\",\"host\":\"string\",\"hivePort\":0,\"authToken\":\"string\",\"lastUpdated\":\"string\",\"hiveHost\":\"string\",\"hiveUser\":\"string\",\"database\":\"string\",\"sslCert\":\"string\",\"hiveDb\":\"string\",\"saveCredentials\":true,\"secretKey\":\"string\",\"container\":\"string\",\"authUrl\":\"string\",\"connectionUrl\":\"string\",\"lift\":[null],\"server\":\"string\",\"user\":\"string\"},\"type\":\"object\"},\"report\":\"string\",\"ddl\":\"string\",\"profile\":true}]},\"type\":\"object\"},\"schedulesURL\":\"string\",\"createdTimeStamp\":\"string\",\"shortDescription\":\"string\",\"lastModifiedTimeStamp\":\"string\",\"createdTool\":\"string\",\"name\":\"string\",\"createdByServiceType\":\"string\",\"URL\":\"string\",\"isRunContinuously\":true,\"activityRunSummary\":{\"description\":\"The current Activity Run Summary (Response only)\",\"xml\":{\"name\":\"activityDetails\"},\"properties\":{\"latestCompletionDate\":\"string\",\"latestStatus\":\"string\",\"runningFromScheduler\":true,\"running\":true,\"latestSubmitDate\":\"string\"},\"type\":\"object\"},\"createdUser\":\"string\"}") .asString();
Request model

docType

STRING , optional

Used to identify activity documents

isSchedulable

BOOLEAN , optional

If the Activity is Schedulable

activityScheduleSummary

object , optional

The Activity Schedule Summary (Response only)

schedules

ARRAY , optional

Schedules for this Activity

id

STRING , optional

The ID of this Schedule

startDate

STRING , optional

The date this Schedule will start

invocationNextDate

STRING , optional

The next Schedule invocation date

status

STRING , optional

The status information for this Schedule

invocationCount

INTEGER , optional

The number of times this Schedule has been invoked

scheduleURL

STRING , optional

The URL of this Schedule

endDate

STRING , optional

The date this Schedule will end

repeat

object , optional

The repeat information for this Schedule

interval

INTEGER , optional

The interval at which the schedule should repeat

repeatWeeks

ARRAY , optional

The weeks of the month when the Activity is scheduled to run

type

STRING , optional

The units used for the interval

repeatDays

ARRAY , optional

The days of the week when the Activity is scheduled to run

isPausable

BOOLEAN , optional

If the Activity is Pausable

expirationDelay

STRING , optional

The time (in hours) after which the activity will be automatically deleted from the system. Use the value 'never' to prevent the activity from expiring

isCancellable

BOOLEAN , optional

If the Activity is Cancellable

isSuspendable

BOOLEAN , optional

If the Activity is Suspendable

lastModifiedUser

STRING , optional

The user that last modified the object (Response only)

version

STRING , optional

The version of the activity schema being used

id

STRING , optional

The ID of the object (Response only)

runsURL

STRING , optional

The URL that can be used to get the list of runs for this activity (Response only)

inputDocument

object , required

The current Activity Input Document

sourceOptions

object , optional

Options to apply to the activity source

nullValueHandling

STRING , optional

Get the null value handling (Hadoop, Lift, S3, Swift, WebHDFS)

firstLineHeader

BOOLEAN , optional

Indicates whether header information, such as column names, is specified in the first row of the file (Hadoop, Lift, S3, Swift, WebHDFS)

relatedTablesData

BOOLEAN , optional

Whether to include data from related tables (DB2)

fieldDelimiter

STRING , optional

Get the field delimiter (Hadoop, Lift, S3, Swift, WebHDFS)

customNullValueText

STRING , optional

Get the custom null value text (Hadoop, Lift, S3, Swift, WebHDFS)

timeFormat

STRING , optional

The time format. The default is %hh:%nn:%ss (Hadoop, Lift, S3, Swift, WebHDFS)

blobTruncationSize

INTEGER , optional

The Blob Truncation Size (DB2)

rowDelimiter

STRING , optional

Get the row delimiter (Hadoop, Lift, S3, Swift, WebHDFS)

readMode

STRING , optional

Whether to read a single file or multiple files (S3)

codepage

INTEGER , optional

Get the code page (Lift)

escapeTarget

STRING , optional

Get the escape target (Hadoop)

clobTruncationSize

INTEGER , optional

The Clob Truncation Size (DB2)

quoteCharacter

STRING , optional

Get the quote character (Hadoop, Lift, S3, Swift, WebHDFS)

encoding

STRING , optional

The file encoding, for example, UTF-8 (Hadoop, Lift, S3, Swift, WebHDFS)

nullValue

STRING , optional

Get the null value (Hadoop, Lift, S3, Swift, WebHDFS)

timeStampFormat

STRING , optional

The timestamp format. The default is %yyyy-%mm-%dd %hh:%nn:%ss (Hadoop, Lift, S3, Swift, WebHDFS)

dateFormat

STRING , optional

The date format. The default is %yyyy-%mm-%dd (Hadoop, Lift, S3, Swift, WebHDFS)

structureInFirstRow

STRING , optional

Indicates whether header information, such as column names, is specified in the first row of the file (Hadoop, Lift, S3, Swift, WebHDFS)

incremental

BOOLEAN , optional

Whether the source data should be migrated incrementally (DB2, Lift, Netezza)

fileStructure

STRING , optional

Get the file structure (Hadoop, Lift, S3, Swift, WebHDFS)

fieldDelimiterChar

STRING , optional

Get the field delimiter char (Hadoop, Lift, S3, Swift, WebHDFS)

rowLimit

INTEGER , optional

Get the row limit (DB2, Netezza)

fileFormat

STRING , optional

Get the file format (Hadoop, Lift, S3, Swift, WebHDFS)

shapingPipelines

ARRAY , optional

Shaping Pipelines

OBJECT , optional

Represents a shaping pipeline

targetOptions

object , optional

Options to apply to the activity target

hiveTable

STRING , optional

The hive table name to use when writing data using the hive connection (WebHDFS)

customHiveTableSuffix

STRING , optional

The custom Hive table suffix (Hadoop)

customHiveTablePrefix

STRING , optional

The custom Hive table prefix (Hadoop)

blobTruncationSize

INTEGER , optional

The Blob Truncation Size (Cloudant)

folderId

STRING , optional

Parent Folder Id, typically a UUID (Watson Analytics)

customTablePrefix

STRING , optional

A prefix to add to the names of target tables. This value applies when target table names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (RDBMS)

assetId

STRING , optional

Asset Id, typically a UUID (Watson Analytics)

hiveTableSchemaCustomName

BOOLEAN , optional

Custom name for the Hive table schema (Hadoop)

clobTruncationSize

INTEGER , optional

The Clob Truncation Size (Cloudant)

inputFormat

STRING , optional

The input format (Cloudant)

hiveTableSchemaName

STRING , optional

The Hive table schema name (Hadoop)

specifyHiveTableSchema

BOOLEAN , optional

Specify the Hive Table Schema (Hadoop)

customFileSuffix

STRING , optional

A suffix to add to the names of target files. This value applies when target files names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (Cloudant, Swift)

customFilePrefix

STRING , optional

A prefix to add to the names of target files. This value applies when target files names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (Cloudant, Swift)

customTableSuffix

STRING , optional

A suffix to add to the names of target tables. This value applies when target table names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (RDBMS)

createHiveTable

BOOLEAN , optional

Whether the hive table should be created or not (WebHDFS)

existingTablesAction

STRING , optional

The action to perform when the target tables already exist (RDBMS)

batchProfilingEnabled

BOOLEAN , optional

Whether Batch Profiling is enabled or not

datasetOption

STRING , optional

The action to perform for source/target datasets

sources

ARRAY , optional

A collection of source physical data resources

id

STRING , optional

The object Id

tables

ARRAY , optional

The collection of tables

id

STRING , optional

The object id

name

STRING , optional

The object display name

datasetId

STRING , optional

The dataset id referenced by this table (only applicable for target tables and only for v3.0 and later)

columns

ARRAY , optional

The table columns

scale

INTEGER , optional

The column scale

precision

INTEGER , optional

The column precision

description

STRING , optional

The column description

name

STRING , optional

The column name

isNullable

BOOLEAN , optional

Whether the column is nullable

type

STRING , optional

The column type

sourceIds

ARRAY , optional

The source ids referenced by this table (only applicable for target tables and only for v2.7 and earlier. For v3.0 this is only supported as a legacy field)

connection

object , optional

The source connection

port

INTEGER , optional

The connection port

region

STRING , optional

The region for this connection

accessKey

STRING , optional

The accessKey for this connection

gateway

STRING , optional

The secure gateway for this connection

bucket

STRING , optional

The bucket for this connection

userid

STRING , optional

The user id (This is different to the user/username and is only required for Bluemix Object Storage currently)

folderPath

STRING , optional

The folder path for this connection

ssl

BOOLEAN , optional

Whether to use ssl for this connection

refreshtoken

STRING , optional

The refresh token for this connection

projectId

STRING , optional

The projectId for this connection

collection

STRING , optional

The collection for this connection

type

STRING , optional

The type of this connection

password

STRING , optional

The connection password

hiveSslEnabled

BOOLEAN , optional

Whether Hive SSL is enabled for this connection

schema

STRING , optional

The connection database schema

id

STRING , optional

The id of this connection

description

STRING , optional

A description of this connection

loginUrl

STRING , optional

The URL to use to access this connection

tenantid

STRING , optional

The tenantid for a butterfly connection

hivePassword

STRING , optional

The Hive Password to use for this connection

serviceenvironment

STRING , optional

The datalake service environment of this connection

sid

STRING , optional

The Oracle sid

accesstoken

STRING , optional

The access token for this connection

host

STRING , optional

The connection host

hivePort

INTEGER , optional

The Hive Port to use for this connection

authToken

STRING , optional

The auth token for this connection

lastUpdated

STRING , optional

When the connection was last updated

hiveHost

STRING , optional

The Hive Host to use for this connection

hiveUser

STRING , optional

The Hive User to use for this connection

database

STRING , optional

The connection database

sslCert

STRING , optional

The self-signed SSL certificate of the database server must be specified in the PEM X.509 format. Only use this property if the ssl property is specified, set to true and if the database server uses an SSL certificate that is not signed by the known CA authority.

hiveDb

STRING , optional

The Hive Database to use for this connection

saveCredentials

BOOLEAN , optional

Whether to save the credentials for this connection

secretKey

STRING , optional

The secret key for this connection

container

STRING , optional

The container for this connection

authUrl

STRING , optional

The auth url for this connection

connectionUrl

STRING , optional

The URL to use to access this connection

lift

ARRAY , optional

The lift details of this connection

server

STRING , optional

The server for this connection

user

STRING , optional

The connection user

targets

ARRAY , optional

A collection of target physical data resources

id

STRING , optional

The object Id

tables

ARRAY , optional

The collection of tables

connection

OBJECT , optional

report

STRING , optional

The DDL conversion report for use with Lift. (Lift only)

ddl

STRING , optional

The DDL for use with Lift (Lift only)

profile

BOOLEAN , optional

Whether the target should be profiled

schedulesURL

STRING , optional

The URL that can be used to get the schedule for this activity (Response only)

createdTimeStamp

STRING , optional

The timestamp when the object was created, in the format yyyy-MM-dd'T'HH:mm:ss.SSS (Response only)

shortDescription

STRING , optional

The description of the object

lastModifiedTimeStamp

STRING , optional

The timestamp when the object was last modified, in the format yyyy-MM-dd'T'HH:mm:ss.SSS (Response only)

createdTool

STRING , optional

The tool used that created the object (Response only)

name

STRING , required

The object name

createdByServiceType

STRING , optional

The service type that created the object (Response only)

URL

STRING , optional

The URL that can be used to get the object (Response only)

isRunContinuously

BOOLEAN , optional

If the Activity is to run continuously

activityRunSummary

object , optional

The current Activity Run Summary (Response only)

latestCompletionDate

STRING , optional

The latest run completion date

latestStatus

STRING , optional

The most recent status of the activity run

runningFromScheduler

BOOLEAN , optional

Whether this activity is running from the Scheduler or not

running

BOOLEAN , optional

Whether this activity is currently running or not

latestSubmitDate

STRING , optional

The latest run submission date

createdUser

STRING , optional

The user that created the object (Response only)

Request example
{
  "docType": string,
  "isSchedulable": boolean,
  "activityScheduleSummary": {
    "schedules": [{
    "id": string,
    "startDate": string,
    "invocationNextDate": string,
    "status": string,
    "invocationCount": integer,
    "scheduleURL": string,
    "endDate": string,
    "repeat": {
    "interval": integer,
    "repeatWeeks": [],
    "type": string,
    "repeatDays": []
  }
  }]
  },
  "isPausable": boolean,
  "expirationDelay": string,
  "isCancellable": boolean,
  "isSuspendable": boolean,
  "lastModifiedUser": string,
  "version": string,
  "id": string,
  "runsURL": string,
  "inputDocument": {
    "sourceOptions": {
    "nullValueHandling": string,
    "firstLineHeader": boolean,
    "relatedTablesData": boolean,
    "fieldDelimiter": string,
    "customNullValueText": string,
    "timeFormat": string,
    "blobTruncationSize": integer,
    "rowDelimiter": string,
    "readMode": string,
    "codepage": integer,
    "escapeTarget": string,
    "clobTruncationSize": integer,
    "quoteCharacter": string,
    "encoding": string,
    "nullValue": string,
    "timeStampFormat": string,
    "dateFormat": string,
    "structureInFirstRow": string,
    "incremental": boolean,
    "fileStructure": string,
    "fieldDelimiterChar": string,
    "rowLimit": integer,
    "fileFormat": string
  },
    "shapingPipelines": [{
    "": object
  }],
    "targetOptions": {
    "hiveTable": string,
    "customHiveTableSuffix": string,
    "customHiveTablePrefix": string,
    "blobTruncationSize": integer,
    "folderId": string,
    "customTablePrefix": string,
    "assetId": string,
    "hiveTableSchemaCustomName": boolean,
    "clobTruncationSize": integer,
    "inputFormat": string,
    "hiveTableSchemaName": string,
    "specifyHiveTableSchema": boolean,
    "customFileSuffix": string,
    "customFilePrefix": string,
    "customTableSuffix": string,
    "createHiveTable": boolean,
    "existingTablesAction": string
  },
    "batchProfilingEnabled": boolean,
    "datasetOption": string,
    "sources": [{
    "id": string,
    "tables": [{
    "id": string,
    "name": string,
    "datasetId": string,
    "columns": [{
    "scale": integer,
    "precision": integer,
    "description": string,
    "name": string,
    "isNullable": boolean,
    "type": string
  }],
    "sourceIds": []
  }],
    "connection": {
    "port": integer,
    "region": string,
    "accessKey": string,
    "gateway": string,
    "bucket": string,
    "userid": string,
    "folderPath": string,
    "ssl": boolean,
    "refreshtoken": string,
    "projectId": string,
    "collection": string,
    "type": string,
    "password": string,
    "hiveSslEnabled": boolean,
    "schema": string,
    "id": string,
    "description": string,
    "loginUrl": string,
    "tenantid": string,
    "hivePassword": string,
    "serviceenvironment": string,
    "sid": string,
    "accesstoken": string,
    "host": string,
    "hivePort": integer,
    "authToken": string,
    "lastUpdated": string,
    "hiveHost": string,
    "hiveUser": string,
    "database": string,
    "sslCert": string,
    "hiveDb": string,
    "saveCredentials": boolean,
    "secretKey": string,
    "container": string,
    "authUrl": string,
    "connectionUrl": string,
    "lift": [],
    "server": string,
    "user": string
  }
  }],
    "targets": [{
    "id": string,
    "tables": [],
    "connection": object,
    "report": string,
    "ddl": string,
    "profile": boolean
  }]
  },
  "schedulesURL": string,
  "createdTimeStamp": string,
  "shortDescription": string,
  "lastModifiedTimeStamp": string,
  "createdTool": string,
  "name": string,
  "createdByServiceType": string,
  "URL": string,
  "isRunContinuously": boolean,
  "activityRunSummary": {
    "latestCompletionDate": string,
    "latestStatus": string,
    "runningFromScheduler": boolean,
    "running": boolean,
    "latestSubmitDate": string
  },
  "createdUser": string
}
Response model

200

Success

Body

docType

STRING , required

Used to identify activity documents

isSchedulable

BOOLEAN , required

If the Activity is Schedulable

activityScheduleSummary

object , required

The Activity Schedule Summary (Response only)

isPausable

BOOLEAN , required

If the Activity is Pausable

expirationDelay

STRING , required

The time (in hours) after which the activity will be automatically deleted from the system. Use the value 'never' to prevent the activity from expiring

isCancellable

BOOLEAN , required

If the Activity is Cancellable

isSuspendable

BOOLEAN , required

If the Activity is Suspendable

lastModifiedUser

STRING , required

The user that last modified the object (Response only)

version

STRING , required

The version of the activity schema being used

id

STRING , required

The ID of the object (Response only)

runsURL

STRING , required

The URL that can be used to get the list of runs for this activity (Response only)

inputDocument

object , required

The current Activity Input Document

schedulesURL

STRING , required

The URL that can be used to get the schedule for this activity (Response only)

createdTimeStamp

STRING , required

The timestamp when the object was created, in the format yyyy-MM-dd'T'HH:mm:ss.SSS (Response only)

shortDescription

STRING , required

The description of the object

lastModifiedTimeStamp

STRING , required

The timestamp when the object was last modified, in the format yyyy-MM-dd'T'HH:mm:ss.SSS (Response only)

createdTool

STRING , required

The tool used that created the object (Response only)

name

STRING , required

The object name

createdByServiceType

STRING , required

The service type that created the object (Response only)

URL

STRING , required

The URL that can be used to get the object (Response only)

isRunContinuously

BOOLEAN , required

If the Activity is to run continuously

activityRunSummary

object , required

The current Activity Run Summary (Response only)

createdUser

STRING , required

The user that created the object (Response only)

schedules

ARRAY , optional

Schedules for this Activity

id

STRING , required

The ID of this Schedule

startDate

STRING , required

The date this Schedule will start

invocationNextDate

STRING , required

The next Schedule invocation date

status

STRING , required

The status information for this Schedule

invocationCount

INTEGER , required

The number of times this Schedule has been invoked

scheduleURL

STRING , required

The URL of this Schedule

endDate

STRING , required

The date this Schedule will end

repeat

object , optional

The repeat information for this Schedule

interval

INTEGER , required

The interval at which the schedule should repeat

repeatWeeks

ARRAY , optional

The weeks of the month when the Activity is scheduled to run

type

STRING , required

The units used for the interval

repeatDays

ARRAY , optional

The days of the week when the Activity is scheduled to run

sourceOptions

object , optional

Options to apply to the activity source

shapingPipelines

ARRAY , optional

Shaping Pipelines

targetOptions

object , optional

Options to apply to the activity target

batchProfilingEnabled

BOOLEAN , required

Whether Batch Profiling is enabled or not

datasetOption

STRING , required

The action to perform for source/target datasets

sources

ARRAY , optional

A collection of source physical data resources

targets

ARRAY , optional

A collection of target physical data resources

nullValueHandling

STRING , required

Get the null value handling (Hadoop, Lift, S3, Swift, WebHDFS)

firstLineHeader

BOOLEAN , required

Indicates whether header information, such as column names, is specified in the first row of the file (Hadoop, Lift, S3, Swift, WebHDFS)

relatedTablesData

BOOLEAN , required

Whether to include data from related tables (DB2)

fieldDelimiter

STRING , required

Get the field delimiter (Hadoop, Lift, S3, Swift, WebHDFS)

customNullValueText

STRING , required

Get the custom null value text (Hadoop, Lift, S3, Swift, WebHDFS)

timeFormat

STRING , required

The time format. The default is %hh:%nn:%ss (Hadoop, Lift, S3, Swift, WebHDFS)

blobTruncationSize

INTEGER , required

The Blob Truncation Size (DB2)

rowDelimiter

STRING , required

Get the row delimiter (Hadoop, Lift, S3, Swift, WebHDFS)

readMode

STRING , required

Whether to read a single file or multiple files (S3)

codepage

INTEGER , required

Get the code page (Lift)

escapeTarget

STRING , required

Get the escape target (Hadoop)

clobTruncationSize

INTEGER , required

The Clob Truncation Size (DB2)

quoteCharacter

STRING , required

Get the quote character (Hadoop, Lift, S3, Swift, WebHDFS)

encoding

STRING , required

The file encoding, for example, UTF-8 (Hadoop, Lift, S3, Swift, WebHDFS)

nullValue

STRING , required

Get the null value (Hadoop, Lift, S3, Swift, WebHDFS)

timeStampFormat

STRING , required

The timestamp format. The default is %yyyy-%mm-%dd %hh:%nn:%ss (Hadoop, Lift, S3, Swift, WebHDFS)

dateFormat

STRING , required

The date format. The default is %yyyy-%mm-%dd (Hadoop, Lift, S3, Swift, WebHDFS)

structureInFirstRow

STRING , required

Indicates whether header information, such as column names, is specified in the first row of the file (Hadoop, Lift, S3, Swift, WebHDFS)

incremental

BOOLEAN , required

Whether the source data should be migrated incrementally (DB2, Lift, Netezza)

fileStructure

STRING , required

Get the file structure (Hadoop, Lift, S3, Swift, WebHDFS)

fieldDelimiterChar

STRING , required

Get the field delimiter char (Hadoop, Lift, S3, Swift, WebHDFS)

rowLimit

INTEGER , required

Get the row limit (DB2, Netezza)

fileFormat

STRING , required

Get the file format (Hadoop, Lift, S3, Swift, WebHDFS)

OBJECT , optional

Represents a shaping pipeline

hiveTable

STRING , required

The hive table name to use when writing data using the hive connection (WebHDFS)

customHiveTableSuffix

STRING , required

The custom Hive table suffix (Hadoop)

customHiveTablePrefix

STRING , required

The custom Hive table prefix (Hadoop)

blobTruncationSize

INTEGER , required

The Blob Truncation Size (Cloudant)

folderId

STRING , required

Parent Folder Id, typically a UUID (Watson Analytics)

customTablePrefix

STRING , required

A prefix to add to the names of target tables. This value applies when target table names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (RDBMS)

assetId

STRING , required

Asset Id, typically a UUID (Watson Analytics)

hiveTableSchemaCustomName

BOOLEAN , required

Custom name for the Hive table schema (Hadoop)

clobTruncationSize

INTEGER , required

The Clob Truncation Size (Cloudant)

inputFormat

STRING , required

The input format (Cloudant)

hiveTableSchemaName

STRING , required

The Hive table schema name (Hadoop)

specifyHiveTableSchema

BOOLEAN , required

Specify the Hive Table Schema (Hadoop)

customFileSuffix

STRING , required

A suffix to add to the names of target files. This value applies when target files names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (Cloudant, Swift)

customFilePrefix

STRING , required

A prefix to add to the names of target files. This value applies when target files names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (Cloudant, Swift)

customTableSuffix

STRING , required

A suffix to add to the names of target tables. This value applies when target table names are not specified manually and target tables are not mapped to source tables by using the sourceIds element (RDBMS)

createHiveTable

BOOLEAN , required

Whether the hive table should be created or not (WebHDFS)

existingTablesAction

STRING , required

The action to perform when the target tables already exist (RDBMS)

id

STRING , required

The object Id

tables

ARRAY , optional

The collection of tables

connection

object , optional

The source connection

id

STRING , required

The object id

name

STRING , required

The object display name

datasetId

STRING , required

The dataset id referenced by this table (only applicable for target tables and only for v3.0 and later)

columns

ARRAY , optional

The table columns

sourceIds

ARRAY , optional

The source ids referenced by this table (only applicable for target tables and only for v2.7 and earlier. For v3.0 this is only supported as a legacy field)

scale

INTEGER , required

The column scale

precision

INTEGER , required

The column precision

description

STRING , required

The column description

name

STRING , required

The column name

isNullable

BOOLEAN , required

Whether the column is nullable

type

STRING , required

The column type

port

INTEGER , required

The connection port

region

STRING , required

The region for this connection

accessKey

STRING , required

The accessKey for this connection

gateway

STRING , required

The secure gateway for this connection

bucket

STRING , required

The bucket for this connection

userid

STRING , required

The user id (This is different to the user/username and is only required for Bluemix Object Storage currently)

folderPath

STRING , required

The folder path for this connection

ssl

BOOLEAN , required

Whether to use ssl for this connection

refreshtoken

STRING , required

The refresh token for this connection

projectId

STRING , required

The projectId for this connection

collection

STRING , required

The collection for this connection

type

STRING , required

The type of this connection

password

STRING , required

The connection password

hiveSslEnabled

BOOLEAN , required

Whether Hive SSL is enabled for this connection

schema

STRING , required

The connection database schema

id

STRING , required

The id of this connection

description

STRING , required

A description of this connection

loginUrl

STRING , required

The URL to use to access this connection

tenantid

STRING , required

The tenantid for a butterfly connection

hivePassword

STRING , required

The Hive Password to use for this connection

serviceenvironment

STRING , required

The datalake service environment of this connection

sid

STRING , required

The Oracle sid

accesstoken

STRING , required

The access token for this connection

host

STRING , required

The connection host

hivePort

INTEGER , required

The Hive Port to use for this connection

authToken

STRING , required

The auth token for this connection

lastUpdated

STRING , required

When the connection was last updated

hiveHost

STRING , required

The Hive Host to use for this connection

hiveUser

STRING , required

The Hive User to use for this connection

database

STRING , required

The connection database

sslCert

STRING , required

The self-signed SSL certificate of the database server must be specified in the PEM X.509 format. Only use this property if the ssl property is specified, set to true and if the database server uses an SSL certificate that is not signed by the known CA authority.

hiveDb

STRING , required

The Hive Database to use for this connection

saveCredentials

BOOLEAN , required

Whether to save the credentials for this connection

secretKey

STRING , required

The secret key for this connection

container

STRING , required

The container for this connection

authUrl

STRING , required

The auth url for this connection

connectionUrl

STRING , required

The URL to use to access this connection

lift

ARRAY , optional

The lift details of this connection

server

STRING , required

The server for this connection

user

STRING , required

The connection user

id

STRING , required

The object Id

tables

ARRAY , optional

The collection of tables

connection

OBJECT , optional

report

STRING , required

The DDL conversion report for use with Lift. (Lift only)

ddl

STRING , required

The DDL for use with Lift (Lift only)

profile

BOOLEAN , required

Whether the target should be profiled

latestCompletionDate

STRING , required

The latest run completion date

latestStatus

STRING , required

The most recent status of the activity run

runningFromScheduler

BOOLEAN , required

Whether this activity is running from the Scheduler or not

running

BOOLEAN , required

Whether this activity is currently running or not

latestSubmitDate

STRING , required

The latest run submission date

404

Activity not found

Body

httpStatus

INTEGER , required

The HTTP response status code

msgSeverity

STRING , required

Message severity

msgSourceCluster

STRING , required

Cluster member ID where the exception was generated (services tier only)

msgSessionId

STRING , required

The caller's session ID

msgExplanation

STRING , required

More detailed explanation of the error, including timestamp and internal diagnostics codes etc

msgExtra

OBJECT , required

The HTTP response status code

msgText

STRING , required

Short summary of the error, ie The activity is invalid as the table name property must be set

msgUserId

STRING , required

The caller's user ID

msgId

STRING , required

Message identifier. Can be any valid IBM SWG message prefix ID, ie CDIFL1234E

msgTimestamp

STRING , required

When the error occurred

msgTenantId

STRING , required

The caller's tenant ID

msgSourceComponent

STRING , required

Source component of the exception

msgResponse

STRING , required

What the user should do about the error (optional) - only provide this if you have a meaninful user action to correct the error

500

Internal Server Error

Body

httpStatus

INTEGER , required

The HTTP response status code

msgSeverity

STRING , required

Message severity

msgSourceCluster

STRING , required

Cluster member ID where the exception was generated (services tier only)

msgSessionId

STRING , required

The caller's session ID

msgExplanation

STRING , required

More detailed explanation of the error, including timestamp and internal diagnostics codes etc

msgExtra

OBJECT , required

The HTTP response status code

msgText

STRING , required

Short summary of the error, ie The activity is invalid as the table name property must be set

msgUserId

STRING , required

The caller's user ID

msgId

STRING , required

Message identifier. Can be any valid IBM SWG message prefix ID, ie CDIFL1234E

msgTimestamp

STRING , required

When the error occurred

msgTenantId

STRING , required

The caller's tenant ID

msgSourceComponent

STRING , required

Source component of the exception

msgResponse

STRING , required

What the user should do about the error (optional) - only provide this if you have a meaninful user action to correct the error

Response example

200

Success

								{
  "docType" : string,
  "isSchedulable" : boolean,
  "activityScheduleSummary" : {
    "schedules" : [{
    "id" : string,
    "startDate" : string,
    "invocationNextDate" : string,
    "status" : string,
    "invocationCount" : integer,
    "scheduleURL" : string,
    "endDate" : string,
    "repeat" : {
    "interval" : integer,
    "repeatWeeks" : [array],
    "type" : string,
    "repeatDays" : [array]
  }
  }]
  },
  "isPausable" : boolean,
  "expirationDelay" : string,
  "isCancellable" : boolean,
  "isSuspendable" : boolean,
  "lastModifiedUser" : string,
  "version" : string,
  "id" : string,
  "runsURL" : string,
  "inputDocument" : {
    "sourceOptions" : {
    "nullValueHandling" : string,
    "firstLineHeader" : boolean,
    "relatedTablesData" : boolean,
    "fieldDelimiter" : string,
    "customNullValueText" : string,
    "timeFormat" : string,
    "blobTruncationSize" : integer,
    "rowDelimiter" : string,
    "readMode" : string,
    "codepage" : integer,
    "escapeTarget" : string,
    "clobTruncationSize" : integer,
    "quoteCharacter" : string,
    "encoding" : string,
    "nullValue" : string,
    "timeStampFormat" : string,
    "dateFormat" : string,
    "structureInFirstRow" : string,
    "incremental" : boolean,
    "fileStructure" : string,
    "fieldDelimiterChar" : string,
    "rowLimit" : integer,
    "fileFormat" : string
  },
    "shapingPipelines" : [{
    "" : object
  }],
    "targetOptions" : {
    "hiveTable" : string,
    "customHiveTableSuffix" : string,
    "customHiveTablePrefix" : string,
    "blobTruncationSize" : integer,
    "folderId" : string,
    "customTablePrefix" : string,
    "assetId" : string,
    "hiveTableSchemaCustomName" : boolean,
    "clobTruncationSize" : integer,
    "inputFormat" : string,
    "hiveTableSchemaName" : string,
    "specifyHiveTableSchema" : boolean,
    "customFileSuffix" : string,
    "customFilePrefix" : string,
    "customTableSuffix" : string,
    "createHiveTable" : boolean,
    "existingTablesAction" : string
  },
    "batchProfilingEnabled" : boolean,
    "datasetOption" : string,
    "sources" : [{
    "id" : string,
    "tables" : [{
    "id" : string,
    "name" : string,
    "datasetId" : string,
    "columns" : [{
    "scale" : integer,
    "precision" : integer,
    "description" : string,
    "name" : string,
    "isNullable" : boolean,
    "type" : string
  }],
    "sourceIds" : [array]
  }],
    "connection" : {
    "port" : integer,
    "region" : string,
    "accessKey" : string,
    "gateway" : string,
    "bucket" : string,
    "userid" : string,
    "folderPath" : string,
    "ssl" : boolean,
    "refreshtoken" : string,
    "projectId" : string,
    "collection" : string,
    "type" : string,
    "password" : string,
    "hiveSslEnabled" : boolean,
    "schema" : string,
    "id" : string,
    "description" : string,
    "loginUrl" : string,
    "tenantid" : string,
    "hivePassword" : string,
    "serviceenvironment" : string,
    "sid" : string,
    "accesstoken" : string,
    "host" : string,
    "hivePort" : integer,
    "authToken" : string,
    "lastUpdated" : string,
    "hiveHost" : string,
    "hiveUser" : string,
    "database" : string,
    "sslCert" : string,
    "hiveDb" : string,
    "saveCredentials" : boolean,
    "secretKey" : string,
    "container" : string,
    "authUrl" : string,
    "connectionUrl" : string,
    "lift" : [array],
    "server" : string,
    "user" : string
  }
  }],
    "targets" : [{
    "id" : string,
    "tables" : [array],
    "connection" : object,
    "report" : string,
    "ddl" : string,
    "profile" : boolean
  }]
  },
  "schedulesURL" : string,
  "createdTimeStamp" : string,
  "shortDescription" : string,
  "lastModifiedTimeStamp" : string,
  "createdTool" : string,
  "name" : string,
  "createdByServiceType" : string,
  "URL" : string,
  "isRunContinuously" : boolean,
  "activityRunSummary" : {
    "latestCompletionDate" : string,
    "latestStatus" : string,
    "runningFromScheduler" : boolean,
    "running" : boolean,
    "latestSubmitDate" : string
  },
  "createdUser" : string
}
							

404

Activity not found

								{
  "httpStatus" : integer,
  "msgSeverity" : string,
  "msgSourceCluster" : string,
  "msgSessionId" : string,
  "msgExplanation" : string,
  "msgExtra" : object,
  "msgText" : string,
  "msgUserId" : string,
  "msgId" : string,
  "msgTimestamp" : string,
  "msgTenantId" : string,
  "msgSourceComponent" : string,
  "msgResponse" : string
}
							

500

Internal Server Error

								{
  "httpStatus" : integer,
  "msgSeverity" : string,
  "msgSourceCluster" : string,
  "msgSessionId" : string,
  "msgExplanation" : string,
  "msgExtra" : object,
  "msgText" : string,
  "msgUserId" : string,
  "msgId" : string,
  "msgTimestamp" : string,
  "msgTenantId" : string,
  "msgSourceComponent" : string,
  "msgResponse" : string
}
							

Loading content...