Skip to content

addAttachments

POST
Use dark colors for code blocksCopy
1
/{orgId}/{itemId}/jobs/{jobId}/attachments
Add an attachment to a job

Add an attachment to a job to provide additional or support information related to the job. The jobUpdateAttachments privilege is required to add an attachment to a job.

Body parameters

Supported content types: multipart/form-data

NameTypeRequiredDescription
tokenstring
attachmentstring(binary)

The file to be uploaded and attached to the job.

aliasstring

Display name for the attachment.

folderstring

Folder under which the attachment will be stored.

stepIdstring

Optional. The Step ID value used to associate the attachment with a specific step.

Path parameters

NameTypeRequired
jobIdstring
orgIdstring
itemIdstring

Response status

StatusMeaningDescriptionSchema
200OK

success

inline
400Bad Request

error

WorkflowExceptionDTO

Response details

Status Code 200

JobAttachmentResult

NameTypeRequiredDescription
aliasstring
urlstring

Examples

Request

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

Response

Use dark colors for code blocksCopy
1
2
3
4
{
  "alias": "string",
  "url": "string"
}

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