You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Deletes a specific attachment from an issue in a project.
57
+
* @summary Your DELETE endpoint
58
+
* @param {string} projectId The ID of the project. Use the Data Management API to retrieve the project ID. For more information, see the Retrieve a Project ID tutorial. You need to convert the project ID into a project ID for the ACC API by removing the “b." prefix. For example, a project ID of b.a4be0c34a-4ab7 translates to a project ID of a4be0c34a-4ab7.
59
+
* @param {string} issueId The unique identifier of the issue. To find the ID, call GET issues.
60
+
* @param {string} attachmentId The unique identifier of the attachment. To find the ID, call GET attachments.
* Retrieves all attachments for a specific issue in a project.
76
+
* For details about retrieving metadata for a specific attachment, see the Retrieve Issue Attachment tutorial.
77
+
* For details about downloading an attachment, see the Download Issue Attachment tutorial.
78
+
* @summary Your GET endpoint
79
+
* @param {string} projectId The ID of the project. Use the Data Management API to retrieve the project ID. For more information, see the Retrieve a Project ID tutorial. You need to convert the project ID into a project ID for the ACC API by removing the “b." prefix. For example, a project ID of b.a4be0c34a-4ab7 translates to a project ID of a4be0c34a-4ab7.
80
+
* @param {string} issueId The unique identifier of the issue. To find the ID, call GET issues.
* The unique identifier for the attachment, set by the client when creating the attachment reference. This can be any unique GUID, but it is recommended to use the OSS storage GUID. For more information, see the Upload Issue Attachment tutorial.
11
+
* @type {string}
12
+
* @memberof Attachment
13
+
*/
14
+
'attachmentId'?: string;
15
+
/**
16
+
* The human-readable display name for the attachment, including the file extension (for example, .pdf, .jpg, .dwg). This name appears in the ACC web UI and is used when downloading the file from the issue.
17
+
* @type {string}
18
+
* @memberof Attachment
19
+
*/
20
+
'displayName'?: string;
21
+
/**
22
+
* The unique filename of the attachment, typically formatted as {attachmentId}.{fileExtension}.
23
+
* This value must exactly match the name of the file stored in Autodesk Docs (OSS) that you uploaded via the OSS process.
24
+
*
25
+
* For more information, see the Upload Issue Attachment tutorial.
26
+
* @type {string}
27
+
* @memberof Attachment
28
+
*/
29
+
'fileName'?: string;
30
+
/**
31
+
* The type of attachment to create. Set to issue-attachment. Will always be: issue-attachment
32
+
* @type {string}
33
+
* @memberof Attachment
34
+
*/
35
+
'attachmentType'?: AttachmentAttachmentTypeEnum;
36
+
/**
37
+
* The Object Storage Service (OSS) URN that uniquely identifies where the file is stored in Autodesk’s cloud infrastructure. You obtain this value after uploading the file to OSS (see the Upload Issue Attachment tutorial) or by retrieving it from an existing attachment (see the Downloading Issue Attachments tutorial).
38
+
* @type {string}
39
+
* @memberof Attachment
40
+
*/
41
+
'storageUrn'?: string;
42
+
/**
43
+
* The size of the file in bytes.
44
+
* @type {number}
45
+
* @memberof Attachment
46
+
*/
47
+
'fileSize'?: number;
48
+
/**
49
+
* The file extension (without the dot), for example pdf or jpg.
50
+
* @type {string}
51
+
* @memberof Attachment
52
+
*/
53
+
'fileType'?: string;
54
+
/**
55
+
* The ID of the issue that owns the attachment.
56
+
* @type {string}
57
+
* @memberof Attachment
58
+
*/
59
+
'domainEntityId'?: string;
60
+
/**
61
+
* The document lineage URN for the attachment’s source file.
62
+
* @type {string}
63
+
* @memberof Attachment
64
+
*/
65
+
'lineageUrn'?: string;
66
+
/**
67
+
* The document version number.
68
+
* @type {number}
69
+
* @memberof Attachment
70
+
*/
71
+
'version'?: number;
72
+
/**
73
+
* The URN for the specific file version that was attached to the issue. This may differ from the latest version URN (tipVersionUrn) if a newer version of the file exists in Autodesk Docs.
74
+
* @type {string}
75
+
* @memberof Attachment
76
+
*/
77
+
'versionUrn'?: string;
78
+
/**
79
+
* The URN for the latest (tip) version of the file.
80
+
* @type {string}
81
+
* @memberof Attachment
82
+
*/
83
+
'tipVersionUrn'?: string;
84
+
/**
85
+
* Not relevant
86
+
* @type {string}
87
+
* @memberof Attachment
88
+
*/
89
+
'bubbleUrn'?: string;
90
+
/**
91
+
* The ID of the user who created the issue attachment. For details about the user, call GET users.
92
+
* @type {string}
93
+
* @memberof Attachment
94
+
*/
95
+
'createdBy'?: string;
96
+
/**
97
+
* The date and time when the issue attachment was created, in ISO8601 format.
98
+
* @type {string}
99
+
* @memberof Attachment
100
+
*/
101
+
'createdOn'?: string;
102
+
/**
103
+
* Not relevant
104
+
* @type {string}
105
+
* @memberof Attachment
106
+
*/
107
+
'modifiedBy'?: string;
108
+
/**
109
+
* Not relevant
110
+
* @type {string}
111
+
* @memberof Attachment
112
+
*/
113
+
'modifiedOn'?: string;
114
+
/**
115
+
* The ID of the user who deleted the issue attachment, if applicable. For details about the user, call GET users.
116
+
* @type {string}
117
+
* @memberof Attachment
118
+
*/
119
+
'deletedBy'?: string;
120
+
/**
121
+
* The date and time when the issue attachment was deleted, if applicable.
122
+
* @type {string}
123
+
* @memberof Attachment
124
+
*/
125
+
'deletedOn'?: string;
126
+
/**
127
+
* true: The attachment has been deleted.
128
+
* false: (default) The attachment has not been deleted.
* The unique identifier for the attachment, set by the client when creating the attachment reference. This can be any unique GUID, but it is recommended to use the OSS storage GUID. For more information, see the Upload Issue Attachment tutorial.
11
+
* @type {string}
12
+
* @memberof AttachmentObject
13
+
*/
14
+
'attachmentId': string;
15
+
/**
16
+
* The human-readable display name for the attachment, including the file extension (for example, .pdf, .jpg, .dwg). This name appears in the ACC web UI and is used when downloading the file from the issue.
17
+
* @type {string}
18
+
* @memberof AttachmentObject
19
+
*/
20
+
'displayName': string;
21
+
/**
22
+
* The unique filename of the attachment, typically formatted as {attachmentId}.{fileExtension}.
23
+
* This value must exactly match the name of the file stored in Autodesk Docs (OSS) that you uploaded via the OSS process.
24
+
*
25
+
* For more information, see the Upload Issue Attachment tutorial.
26
+
* @type {string}
27
+
* @memberof AttachmentObject
28
+
*/
29
+
'fileName': string;
30
+
/**
31
+
* The type of attachment to create. Set to issue-attachment. Will always be: issue-attachment
* The Object Storage Service (OSS) URN that uniquely identifies where the file is stored in Autodesk’s cloud infrastructure. You obtain this value after uploading the file to OSS (see the Upload Issue Attachment tutorial) or by retrieving it from an existing attachment (see the Downloading Issue Attachments tutorial).
0 commit comments