Updating a Task

Function

This API is used to update a sensitive data identification task.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/sdg/scan/job/{job_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which is used to identify a specific project.
job_id	Yes	String	Task ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
asset_ids	Yes	Array of strings	Asset ID list
cycle	Yes	String	Scanning period, which can be DAY, WEEK, MONTH, or ONCE.
name	Yes	String	Scanning task name
open	No	Boolean	Whether to enable the task
rule_group_ids	Yes	Array of strings	Rule group ID list
start_time	No	Long	Start time of a scanning task
time_zone	No	String	Time zone
topic_urn	No	String	Unique resource identifier of a topic
use_nlp	No	Boolean	Whether to use NLP

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
msg	String	Returned message
status	String	Return status, for example, '200', '400'.

Status code: 201

Created

Example Requests

PUT /v1/{project_id}/sdg/scan/job/{job_id}

{
  "asset_ids" : [ "xxx", "xxx" ],
  "rule_group_ids" : [ "xxx", "xxx" ],
  "cycle" : "string",
  "name" : "string"
}

Example Responses

None

Status Codes

Status Code	Description
200	OK
201	Created
401	Unauthorized. The user is not logged in or the token is invalid.
403	Unauthorized to access the resource.
404	The specified project does not exist.