Exporting a Job¶

Function¶

This API is used to export a job, including job definitions, job dependency scripts, and CDM job definitions.

URI¶

URI format
POST /v1/{project_id}/jobs/{job_name}/export
Parameter description
Table 1 URI parameters¶
Parameter
Mandatory
Type
Description
project_id
Yes
String
Project ID. For details about how to obtain a project ID, see Project ID and Account ID.
job_name
Yes
String
Job name.

**Table 1** URI parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain a project ID, see Project ID and Account ID.
job_name	Yes	String	Job name.

Request Parameters¶

**Table 2** Request header parameter¶
Parameter	Mandatory	Type	Description
workspace	No	String	Workspace ID. If this parameter is not set, data in the default workspace is queried by default. To query data in other workspaces, this header must be carried.

Response Parameters¶

The value of Content-Type in the response message is application/octet-stream that needs to be converted into a file. For details, see Parsing a Stream in a Response Message. Response messages are compressed as a file. The file name format is DLF_job_name.zip. The file directory is as follows:

jobs
├─{job_name}.job
scripts
├─{script_name}.script
resources
├─{resource_name}.resource

Table 3 describes the file directory parameters.

**Table 3** Response parameters¶
Parameter	Mandatory	Type	Description
job_name	Yes	String	Job name.
script_name	No	String	Name of the script that the job depends on.
resource_name	No	String	Name of the resource that the job depends on.

{job_name}.job
The parameters in the file are the same as the request parameters of the API for creating a job. For details, see Creating a Job.
{script_name}.script
The parameters in the file are the same as the request parameters of the API for creating a resource. For details, see Creating a Script.

Example Request¶

Export job myJob.

POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/myJob/export

Example Response¶

Success response
HTTP status code 200
The name of the exported file is DLF_myJob.zip. The file structure after decompression is as follows:
```
jobs
├─myJob.job
scripts
├─CS_PROCESS_TRIP.script
├─TRIP_RAW_STANDARD.script
```

Failure response

HTTP status code 400

{
    "error_code":"DLF.0100",
    "error_msg":"The job does not exists."
}

last updated: 2024-11-13 13:47 UTC - commit: db9c60a6c98025320fa32706a5e58cd02cf7d7f1