addAttachmentsLinked

POST
Use dark colors for code blocksCopy
/{orgId}/{itemId}/jobs/{jobId}/attachmentslinked

Add linked attachments to a job

Add linked attachments to a job to provide additional or support information related to the job. Linked attachments can be links to a file on a local or shared file system or a URL. The jobUpdateAttachments privilege is required to add an attachment to a job.

Query parameters

Name	Type	Required
`token`	`string¦null`

Body parameters

Supported content types: application/json

Type: JobAttachmentLinkedBody

Array of linked attachments to assoicate with the job

Name	Type	Required
`attachments`	`[JobAttachmentLinked]`
`stepId`	`string¦null`

Path parameters

Name	Type	Required
`jobId`	`string`
`orgId`	`string`
`itemId`	`string`

Response status

Status	Meaning	Description	Schema
200	OK	List of added attachments	inline
400	Bad Request	error	WorkflowExceptionDTO

Response details

Status Code 200

JobAttachmentLinkedResults

Name	Type	Required	Description
`attachments`	`[JobAttachmentLinkedResult]`

Examples

Request

Use dark colors for code blocksCopy
# You can also use wget
curl -X POST /{orgId}/{itemId}/jobs/{jobId}/attachmentslinked \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <YOUR_TOKEN>' \
  --data '{"attachments":[{"url":"string","alias":"string","folder":"string"}],"stepId":"string"}'

Response

Use dark colors for code blocksCopy
{
  "attachments": [
    {
      "alias": "string",
      "attachmentId": "string"
    }
  ]
}