Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Attachment Management/ Uploading an Attachment
Updated on 2025-12-18 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Uploading an Attachment

Function

This API is used to upload an attachment to OBS.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/attachment/upload

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Definition

Workspace ID.

Range

N/A

Request Parameters

Table 2 FormData parameters

Parameter

Mandatory

Type

Description

fileType

No

String

Fixed value. Currently, only user_task tasks are supported.

uploadFile

Yes

File

Imported workflow file.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

String

Error code.

message

String

Error message.

success

Boolean

Request status.

request_id

String

Request ID.

data

UploadAttachmentInfo object

Attachment content returned during upload.
Table 4 UploadAttachmentInfo

Parameter

Type

Description

id

String

Attachment ID.

file_name

String

Attachment name.

workspace_id

String

ID of the current workspace.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Object returned upon a successful response.

400

Object returned upon a response error.

Error Codes

See Error Codes.

Parent topic: Attachment Management