getAttachments

Click to copy

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: Date and time stamp 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

token

string

Path parameters

NameTypeRequired

jobId

string

orgId

string

itemId

string

Examples

Request

Use dark colors for code blocksCopy
1
2
3
4
# You can also use wget
curl -X GET /{orgId}/{itemId}/jobs/{jobId}/attachments \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Response

200 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"
    }
  ]
}
StatusMeaningDescriptionSchema

200

OK

List of attachments for a job

Inline

400

Bad Request

error

WorkflowExceptionDTO

Response details

Status Code 200

JobAttachmentDescriptions

NameTypeRequired

attachments

id

string

alias

string¦null

folder

string¦null

url

string¦null

lastModifiedBy

string¦null

lastModified

string(date-time)¦null

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