KronoDesk: REST Web Service (v4.0)


Click here for a complete list of operations.

POST: documents

Description

Adds a new document or URL link into the system and associates it with the provided artifact

How to Execute

To access this REST web service, you need to use the following URL:

http://api.inflectra.com/KronoDesk/Services/v1_0/RestService.svc/documents

Request Body

Property Description
BinaryData The contents of the file attachment
AttachmentId The id of the attachment
AttachmentTypeId The id of the attachment typeFile = 1, URL = 2
ArtifactTypeId The id of the type of artifact it's attached toNone = -1, Forum = 1, Thread = 2, Message = 3, User = 4, Article = 5, Ticket = 6, Placeholder = 7
ArtifactId The id of the artifact it's being attached to
AuthorId The id of the user that uploaded the attachmentIf no value is provided, the authenticated user is used
FilenameOrUrl The filename of the file (if a file attachment) or the full URL if a URL attachment
Description The description of the attachment
UploadDate The date/time the attachment was uploaded
Size The size of the attachment in bytesPass 0 for a URL attachment
Hash The MD5 hash of the file's contents.
AuthorName The display name of the user that uploaded the attachment
DocumentURL Returns the url to directly access the document.

Return Data

Property Description
AttachmentId The id of the attachment
AttachmentTypeId The id of the attachment typeFile = 1, URL = 2
ArtifactTypeId The id of the type of artifact it's attached toNone = -1, Forum = 1, Thread = 2, Message = 3, User = 4, Article = 5, Ticket = 6, Placeholder = 7
ArtifactId The id of the artifact it's being attached to
AuthorId The id of the user that uploaded the attachmentIf no value is provided, the authenticated user is used
FilenameOrUrl The filename of the file (if a file attachment) or the full URL if a URL attachment
Description The description of the attachment
UploadDate The date/time the attachment was uploaded
Size The size of the attachment in bytesPass 0 for a URL attachment
Hash The MD5 hash of the file's contents.
AuthorName The display name of the user that uploaded the attachment
DocumentURL Returns the url to directly access the document.