REST API Reference

REST API Reference

Jobs

Jobs

The jobs request performs a reset of a specific data set.

Resource URL

/tdw/v1/jobs

HTTP Request

POST http(s)://
<host>
:
<port>
/api/public/tdw/v1/jobs

Request Header

The request header includes the following headers:
Header
Description
accept
Use the following value:
application/json
Authorization
Required. Use the following value:
Basic <user name>

Request Body

The request body includes the following property values:
Property
Data Type
Description
target_connection_name
String
Required. Connection to use as the target for the reset.
target_connection_schema_name
String
Schema in the target connection.
staging_connection_name
String
Required. Name of the staging connection to use in the reset task.
truncate_target_table
Boolean
Truncates the table before loading it. Default is false.
disable_triggers
Boolean
Disables DML triggers on the target database before loading the data to the target and enables the triggers after the data loads. Default is false.
disable_indexes
Boolean
Disables indexes for faster loading. Default is false.
dataset_version_id
String
Required. ID of the data set that you want to reset.
integration_service_name
String
Required. The name of the Integration Service to run the task.
locale_code
String
Sets the locale.
upsert_in_transactional_table
Boolean
Performs an upsert on transactional tables instead of an insert. Default is false.
stop_on_error
Integer
Indicates how many non fatal errors the Integration Service encounters before it stops the session. If you enter zero, the session does not stop for non fatal errors. Default is zero.
enable_high_precision
Boolean
Processes the decimal data type to a precision of 28. Default is false.
manual_disable_constraint
Boolean
Disable the constraints manually during the reset. Default is false.
enable_recovery
Boolean
Enables the reset recovery options. Default is false.
enable_special_characters_in_metadata
Boolean
Enables the support for special characters in metadata. Default is false.
target_load_type
String
The target load type. You can choose Normal or Bulk.
If you choose Normal, the PowerCenter Integration Service loads targets normally. Choose Normal mode if the mapping contains an Update Strategy transformation.
Choose Bulk to improve session performance. Bulk load limits the ability to recover because no database logging occurs.
Default is Normal.
max_parallel_sessions
Integer
The maximum number of sessions that can run at the same time. Applicable if you disable indexes and constraints in the target.
max_tables_per_mapping
Integer
Sets the number of tables to process in a workflow. Default is 10.
schedule_on
Integer
Date and time at which you want to schedule the job to run. Enter the time in milliseconds.
skip_constraints_validation
String
Skips constraint validation when enabling constraints.
backup_recovery_prefix
String
A prefix for the backup schema. TDM creates a backup schema in the format prefix_tablename.
backup_recovery_user_name
String
The name of the schema where you want to store the backup tables.
target_prefix_name
String
The name prefix of the target table. Specify the target schema name if the target is in a different schema.

Sample Request

http://<host>:6605/api/public/tdw/v1/jobs

Sample Request Body

{ "target_connection_name": "SRC_OT1543865636189", "staging_connection_name": "TDM_CONNECTION", "dataset_version_id": "5b24e361-8825-440c-a73b-b7307f533f6f", "integration_service_name": "PIS" }

Sample Response

{ "id": 236, "name": "Reset Data Set from Test Data Warehouse", "description": "Reset - Entity Version1 - from Test Data Warehouse - OracleMart", "status": "In Queue", "start_date": 0, "end_date": 0, "job_type": "Reset Data Set from Test Data Warehouse", "created_by_name": null, "creation_date": 1543897440502, "creation_date_str": "12/04/2018 09:54:00 AM", "last_updated_date": 1543897440502, "last_updated_date_str": "12/04/2018 09:54:00 AM", "last_updated_by_name": null, "schedule_on": 0, "paused_at_step": 0, "percent_complete": 0, "job_action_type": null, "child_job_id": -1 }

0 COMMENTS

We’d like to hear from you!