Help Center> DataArts Studio> API Reference> DataArts Factory APIs> Job Development APIs> Changing a Job Name
Updated on 2024-04-29 GMT+08:00
View PDF

Changing a Job Name

Function

This API is used to change the name of a job.

URI

  • URI format

    PUT /v2/{project_id}/factory/jobs/{job_name}/rename

  • 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

Request Parameters

Table 2 Request header parameters

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.

X-Auth-Token

No

String

This parameter is mandatory for token authentication. The length of a user token must meet the following requirements:

Minimum length: 0

Maximum length: 4096

Content-Type

No

String

This parameter is mandatory if the body is available. If the body is unavailable, you do not need to set and verify this parameter.

Example: Content-Type: application/json;charset=UTF-8

Authorization

No

String

This field is mandatory for AK/SK authentication.

Host

No

String

This field is mandatory for AK/SK authentication.
Table 3 Body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Job name

Response Parameters

Table 4 Parameter description

Parameter

Mandatory

Type

Description

is_success

Yes

Boolean

true or false

status_code

Yes

Integer

Response status code

Example Request

PUT /v2/62099355b894428e8916573ae635f1f9/factory/jobs/job_2284221/rename

{
	"name": "job_4269F"
}

Example Response

  • Success response

    HTTP status code 200

    {
    "is_success": true,
    "status_code": 200
}
  • Failure response

    HTTP status code 400

    {
    "error_code": "DLF.30100",
    "error_msg": "Job[job_2284221] does not exist"
}
Parent topic: Job Development APIs