Jump to

• Request
• Response

Runs a Data Tools job

post

/data-tools/jobs/run

Runs a Data Tools job

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

201 Response

Data Tools job

Body ()

Root Schema : schema

Type: object

Show Source

• description: string
  Descrip1tion of the Data Tools job

  Example: My job to load and manipulate data
• end_date: string
  A data and time of the format YYYY-MM-DDTHH24:MI:SS.FFTZH:TZM

  Example: 2009-08-12T07:47:21.212121000-04:00
• job_name: string
  Example: LOAD_AND_MODIFY_SALES
• owner: string
  Database object schema

  Example: SH
• repeat_interval: string
  DBMS_SCHEDULER interval for Data Tools job

  Example: FREQ=DAILY;BYHOUR=9;BYMINUTE=30;BYDAY=MON,TUE,WED,THU,FRI
• reporting: object data-tools-job-reporting
• start_date: string
  A data and time of the format YYYY-MM-DDTHH24:MI:SS.FFTZH:TZM

  Example: 2009-08-12T07:47:21.212121000-04:00
• steps: array steps

{
    "type":"object",
    "properties":{
        "job_name":{
            "$ref":"#/components/schemas/data_tools_job_name"
        },
        "owner":{
            "$ref":"#/components/schemas/schema_name"
        },
        "description":{
            "type":"string",
            "example":"My job to load and manipulate data",
            "description":"Descrip1tion of the Data Tools job"
        },
        "steps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/data_tools_step"
            },
            "example":[
                {
                    "type":"data_load",
                    "step_name":"Load the SALES table",
                    "data_load_name":"SALES_LOAD",
                    "on_errors":"stop"
                },
                {
                    "type":"smart_table",
                    "step_name":"Get the birth year from the date",
                    "recipe":"EXTRACT_BIRTH_YEAR_FROM_DATE",
                    "on_errors":"continue"
                },
                {
                    "type":"procedure",
                    "procedure":"DBMS_OUTPUT.PUT_LINE",
                    "arguments":[
                        "Print this!"
                    ]
                },
                {
                    "type":"http",
                    "url":"https://data-tools-enthusiast.adb.us-ashburn-1.oraclecloudapps.com/my-endpoint",
                    "method":"POST",
                    "credential_name":"MYAUTHTOKEN",
                    "body":"{ \"status\": \"done\" }"
                }
            ]
        },
        "start_date":{
            "$ref":"#/components/schemas/live_feed_timestamp",
            "example":"2009-08-12T07:47:21.212121000-04:00"
        },
        "repeat_interval":{
            "type":"string",
            "example":"FREQ=DAILY;BYHOUR=9;BYMINUTE=30;BYDAY=MON,TUE,WED,THU,FRI",
            "description":"DBMS_SCHEDULER interval for Data Tools job"
        },
        "end_date":{
            "$ref":"#/components/schemas/live_feed_timestamp",
            "example":"2013-06-05T06:36:21.212121000-04:00"
        },
        "reporting":{
            "$ref":"#/components/schemas/data-tools-job-reporting"
        }
    }
}

Nested Schema : data-tools-job-reporting

Type: object

Show Source

• completed: object data-tools-job-reporting-options
• errors: object data-tools-job-reporting-options
• failed: object data-tools-job-reporting-options

{
    "type":"object",
    "properties":{
        "completed":{
            "$ref":"#/components/schemas/data-tools-job-reporting-options"
        },
        "errors":{
            "$ref":"#/components/schemas/data-tools-job-reporting-options"
        },
        "failed":{
            "$ref":"#/components/schemas/data-tools-job-reporting-options"
        }
    }
}

Nested Schema : steps

Type: array

Show Source

• Array of: object Discriminator: type
  Discriminator: { "propertyName":"type", "mapping":{ "data_load":"data_tools_step_data_load", "smart_table":"data_tools_step_smart_table", "procedure":"data_tools_step_procedure", "live_feed":"data_tools_step_live_feed", "http":"data_tools_step_http" } }

  Step of a Data Tools job

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/data_tools_step"
    },
    "example":[
        {
            "type":"data_load",
            "step_name":"Load the SALES table",
            "data_load_name":"SALES_LOAD",
            "on_errors":"stop"
        },
        {
            "type":"smart_table",
            "step_name":"Get the birth year from the date",
            "recipe":"EXTRACT_BIRTH_YEAR_FROM_DATE",
            "on_errors":"continue"
        },
        {
            "type":"procedure",
            "procedure":"DBMS_OUTPUT.PUT_LINE",
            "arguments":[
                "Print this!"
            ]
        },
        {
            "type":"http",
            "url":"https://data-tools-enthusiast.adb.us-ashburn-1.oraclecloudapps.com/my-endpoint",
            "method":"POST",
            "credential_name":"MYAUTHTOKEN",
            "body":"{ \"status\": \"done\" }"
        }
    ]
}

Example:

[
    {
        "type":"data_load",
        "step_name":"Load the SALES table",
        "data_load_name":"SALES_LOAD",
        "on_errors":"stop"
    },
    {
        "type":"smart_table",
        "step_name":"Get the birth year from the date",
        "recipe":"EXTRACT_BIRTH_YEAR_FROM_DATE",
        "on_errors":"continue"
    },
    {
        "type":"procedure",
        "procedure":"DBMS_OUTPUT.PUT_LINE",
        "arguments":[
            "Print this!"
        ]
    },
    {
        "type":"http",
        "url":"https://data-tools-enthusiast.adb.us-ashburn-1.oraclecloudapps.com/my-endpoint",
        "method":"POST",
        "credential_name":"MYAUTHTOKEN",
        "body":"{ \"status\": \"done\" }"
    }
]

Nested Schema : data-tools-job-reporting-options

Type: object

Show Source

• smtp: array email-array

{
    "type":"object",
    "properties":{
        "smtp":{
            "$ref":"#/components/schemas/email-array"
        }
    }
}

Nested Schema : email-array

Type: array

Show Source

• Array of: string
  Email address to notify

  Example: [e-mail]

{
    "type":"array",
    "example":[
        "[e-mail]",
        "[e-mail]"
    ],
    "items":{
        "description":"Email address to notify",
        "type":"string",
        "example":"[e-mail]"
    }
}

Example:

[
    "[e-mail]",
    "[e-mail]"
]

Nested Schema : Discriminator: type

Type: object

Discriminator: type

Discriminator Values

{
    "type":"object",
    "description":"Step of a Data Tools job",
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "data_load":"data_tools_step_data_load",
            "smart_table":"data_tools_step_smart_table",
            "procedure":"data_tools_step_procedure",
            "live_feed":"data_tools_step_live_feed",
            "http":"data_tools_step_http"
        }
    },
    "properties":{
        "type":{
            "type":"string",
            "example":"data_load",
            "description":"Type of step",
            "enum":[
                "data_load",
                "smart_table",
                "procedure",
                "live_feed",
                "http"
            ]
        },
        "step_name":{
            "type":"string",
            "example":"LOAD_MY_TABLE",
            "description":"Optional name of step"
        },
        "on_errors":{
            "type":"string",
            "example":"continue",
            "description":"Action when encountering step error",
            "enum":[
                "stop",
                "continue"
            ]
        }
    },
    "required":[
        "type"
    ]
}

Step of a Data Tools job

Show Source

• on_errors: string
  Allowed Values: [ "stop", "continue" ]

  Action when encountering step error

  Example: continue
• step_name: string
  Optional name of step

  Example: LOAD_MY_TABLE
• type(required): string
  Allowed Values: [ "data_load", "smart_table", "procedure", "live_feed", "http" ]

  Type of step

  Example: data_load

{
    "type":"object",
    "description":"Step of a Data Tools job",
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "data_load":"data_tools_step_data_load",
            "smart_table":"data_tools_step_smart_table",
            "procedure":"data_tools_step_procedure",
            "live_feed":"data_tools_step_live_feed",
            "http":"data_tools_step_http"
        }
    },
    "properties":{
        "type":{
            "type":"string",
            "example":"data_load",
            "description":"Type of step",
            "enum":[
                "data_load",
                "smart_table",
                "procedure",
                "live_feed",
                "http"
            ]
        },
        "step_name":{
            "type":"string",
            "example":"LOAD_MY_TABLE",
            "description":"Optional name of step"
        },
        "on_errors":{
            "type":"string",
            "example":"continue",
            "description":"Action when encountering step error",
            "enum":[
                "stop",
                "continue"
            ]
        }
    },
    "required":[
        "type"
    ]
}

204 Response

No content

Back to Top