REST API Reference

10.5
- 10.5.3
- 10.5.2
- 10.5.1
- 10.4.1
- 10.4.0

Back Next

Jobs

The jobs request performs a deploy or a reset or restore of a specific data pack.

Resource URL

/ssp/v1/jobs

HTTP Request

POST http(s)://<host>:<port>/api/public/ssp/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
data_pack_name	String	Required. Name of the data pack.
job_type	String	Required. You can choose from: Deploy. Creates the workflows required to perform reset and restore. Reset. Runs the workflow to reset a data pack to a target connection. Restore. Runs the workflow to restore a data pack to a target connection.
target_connection_name	String	Required. Connection to use as the target for the job.
target_connection_schemaname	String	Schema in the target connection.
target_jdbc_connection	String	The connection that contains the JDBC connection string of the ODBC target database. Required to disable and enable constraints in the plan. Required if the target connection type is ODBC.
reset_criteria	String	Enter reset criteria if you want to reset specific data from a data pack. Enter row-level tags as reset criteria.
integration_service_name	String	Required. The name of the Integration Service to run the task.
schedule_on	Integer	Date and time at which you want to schedule the job to run. Enter the time in milliseconds.

Sample Request

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

Sample Request Body

{
  "data_pack_name": "DataPackFromPlan",
  "job_type": "Deploy",
  "target_connection_name": "SRC_OT1543865636189"
}

Sample Response

{
  "id": 244,
  "name": "Generate Workflow",
  "description": "Creates a workflow to reset data pack: DataPackFromPlan",
  "status": "In Queue",
  "start_date": 0,
  "end_date": 0,
  "job_type": "Generate Workflow",
  "created_by_name": null,
  "creation_date": 1543903617179,
  "creation_date_str": "12/04/2018 11:36:57 AM",
  "last_updated_date": 1543903617179,
  "last_updated_date_str": "12/04/2018 11:36:57 AM",
  "last_updated_by_name": null,
  "schedule_on": 0,
  "paused_at_step": 0,
  "percent_complete": 0,
  "job_action_type": null,
  "child_job_id": -1
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Jobs

Jobs

Resource URL

HTTP Request

Request Header

Request Body

Sample Request

Sample Request Body

Sample Response