Table of Contents

Search

  1. Preface
  2. Informatica Intelligent Cloud Services REST API
  3. Platform REST API version 2 resources
  4. Platform REST API version 3 resources
  5. Data Integration REST API
  6. Mass Ingestion Files REST API
  7. Mass Ingestion Streaming REST API
  8. RunAJob utility
  9. ParamSetCli utility
  10. REST API codes
  11. REST API resource quick references

REST API Reference

REST API Reference

View a code task

View a
code task

Use this GET request to view the
code task
configuration parameters.

GET request

To request the parameters of a
code task
, use the task ID. The
code task
ID is included in the response when you create a
code task
. For more information, see Create.
Use the following URI to get the
code task
parameters:
GET <server URL>/disnext/api/v1/CodeTask/<Code task ID>

GET response

Returns the
code task
object for the requested task ID.
Returns the error object if errors occurred.
The following table describes the parameters in the response:
Field
Type
Description
codeTaskName
String
Name of the
code task
.
codeTaskId
Numeric
The
code task
identifier.
agentGroupId
String
Runtime environment that contains the Secure Agent used to run the
code task
.
overrideTaskTimeout
String
Overrides the code task timeout value for this execution. A value of -1 signifies no timeout.
logLevel
String
Log level for session logs, agent job log, Spark driver, and executor logs. Valid values are: none, terse, normal, verboseInitialization, or verboseData.
The default value is normal.
sparkMainClass
String
Entry point of the Spark application. For example:
org.apache.spark.examples.company.SparkExampleApp
sparkMainClassArgs
List<String>
Ordered arguments sent to the Spark application main class. For example:
--appTypeSPARK_PI_FILES_JARS--
classesToLoadcom.company.test.SparkTest1Class
sparkPrimaryResource
String
Scala JAR file that contains the
code task
.
sparkJars
List <String>
The directory and file name of the JAR file that is uploaded to the cluster and added to the Spark driver and executor classpaths.
sparkFiles
List <String>
The directory and file name of the Spark file that is uploaded to the cluster and available under the current working directory.
advancedCustomProperties
String
Spark properties or other custom properties that
Data Integration
uses.

GET request example

Use this sample as a reference to get the
code task
parameters.
GET <server URL>/disnext/api/v1/CodeTask/<Code task ID> Content-Type: application/json Accept: application/json IDS-SESSION-ID:{{IDS_SESSION_ID}}

GET response example

A successful GET response returns the
code task
parameters, similar to the following example:
{ "codeTaskName": "CODETASK_API", "codeTaskId": 3, "agentGroupId": "01000025000000000003", "overrideTaskTimeout": null, "logLevel": "normal", "sparkMainClass": "org.apache.spark.examples.infa.sparkdirect.SparkDirectExampleApp", "sparkMainClassArgs": ["6"], "sparkPrimaryResource": "spark-examples_2.12-3.0.0.jar", "sparkJars": [], "sparkFiles": [], "advancedCustomProperties": "{\"spark.driver.memory\": \"1G\", \"spark.executor.memory\": \"1G\", \"spark.kubernetes.driverEnv.SPARK_DIRECT_TASK_SLEEP\": \"600\", \"spark.kubernetes.driverEnv.SPARK_DIRECT_APP_TYPE\": \"SPARK_PI\", \"spark.kubernetes.driverEnv.SPARK_DIRECT_KMS_ENCRYPTED_PROPS\": \"spark.sparkdirect.kms.prop\", \"spark.sparkdirect.kms.prop\": \"5pkOjS0HILDwSaW6eyxtiwB3g2TBYayjKLRFSSyxn5M=0p6v3eCvrtFkw6K78Buwal\", \"advanced.custom.property\": \"infa.spark.local=false\"}" }

0 COMMENTS

We’d like to hear from you!