Skip to content

getAttachments

GET
Use dark colors for code blocksCopy
1
/{orgId}/{itemId}/jobs/{jobId}/attachments
Get job attachments

Retrieves the list of attachments associated with a job.

If the job contains attachments, they are returned in an attachments array with the following information:

  • id: Attachment id for the attachment associated with a job.
  • alias: Display name for the attachment.
  • folder: The folder in which the attachment is saved. Folder name can be blank.
  • url: Link for the attachment that consists of the jobId and the attachmentId.
  • lastModifiedBy: Username for the user who added or updated the attachment on the job.
  • lastModified: The timestamp in RFC3339 format for when the attachment was created or updated on the job. This field will not be modified if only the alias or the folder name for the attachment have been updated.

Query parameters

NameTypeRequired
tokenstring¦null

Path parameters

NameTypeRequired
jobIdstring
orgIdstring
itemIdstring

Response status

StatusMeaningDescriptionSchema
200OK

List of attachments for a job

inline
400Bad Request

error

WorkflowExceptionDTO

Response details

Status Code 200

JobAttachmentDescriptions

NameTypeRequiredDescription
attachments[JobAttachmentDescription]

Examples

Request

Use dark colors for code blocksCopy
1
2
3
# You can also use wget
curl -X GET /{orgId}/{itemId}/jobs/{jobId}/attachments \
  -H 'Authorization: Bearer <YOUR_TOKEN>'

Response

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
{
  "attachments": [
    {
      "id": "string",
      "alias": "string",
      "folder": "string",
      "url": "string",
      "lastModifiedBy": "string",
      "lastModified": "2019-08-24T14:15:22Z"
    }
  ]
}

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