Skip to content

updateAttachments

POST
Use dark colors for code blocksCopy
1
/{orgId}/{itemId}/jobs/{jobId}/attachments/{attachmentId}
Update existing embedded or linked attachment on a job

Update alias and folder names for existing attachments associated with a job. The jobUpdateAttachments privilege is required to update attachments on a job.

Body parameters

Supported content types: multipart/form-data

NameTypeRequiredDescription
tokenstring
aliasstring

Updated display name for the attachment. Alias cannot be set to null.

folderstring

New folder under which the attachment will be stored.

Path parameters

NameTypeRequired
jobIdstring
attachmentIdstring
orgIdstring
itemIdstring

Response status

StatusMeaningDescriptionSchema
200OK

success

Success
400Bad Request

error

WorkflowExceptionDTO

Examples

Request

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
# You can also use wget
curl -X POST /{orgId}/{itemId}/jobs/{jobId}/attachments/{attachmentId} \
  -H 'Content-Type: multipart/form-data' \
  -H 'Authorization: Bearer <YOUR_TOKEN>' \
  -F token=string \
  -F alias=string \
  -F folder=string

Response

Use dark colors for code blocksCopy
1
2
3
{
  "success": true
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.