Relative request path: | api/orgs/{organisationId}/documents/{documentId}/attachments/{documentAttachmentId} |
Property | Description |
---|---|
organisationId | organisation id |
documentId | document id |
documentAttachmentId | document attachment id |
Request parameters:
Request parameters:
Request parameters:
Property | Description |
---|---|
DocumentAttachmentId | Document attachment id. |
Document | class Document. Document. |
Description | Attachment description. |
AttachmentData | Attachment data. |
FileName | Attachment name for file. |
MimeType | Attachment mime type. |
EntryDate | Entry date. |
RecordDtModified | |
RowVersion | Row version is used for concurrency check. |
This method returns result of type 'SAOP.API.Models.Document.DocumentAttachment'.
/// Document attachment details.
public class DocumentAttachment
{
// Document attachment id.
// Ignored on create request.
public long DocumentAttachmentId { get; set; }
// Document.
public mMApiFkField Document { get; set; }
// Attachment description.
public string Description { get; set; }
// Attachment data.
public string AttachmentData { get; set; }
// Attachment name for file.
public string FileName { get; set; }
// Attachment mime type.
public string MimeType { get; set; }
// Entry date.
public DateTime EntryDate { get; set; }
public DateTime RecordDtModified { get; set; }
// Row version is used for concurrency check.
// Ignored on create request.
public string RowVersion { get; set; }
}
/// Link with id, name and url to related data.
public class mMApiFkField
{
// Record id.
public long? ID { get; set; }
// Record name.
public string Name { get; private set; }
// Url to full record details.
public string ResourceUrl { get; private set; }
}
This method returns result of type 'SAOP.API.Models.Document.DocumentAttachment'.
/// Document attachment details.
class DocumentAttachment
{
// Document attachment id.
// Ignored on create request.
public $DocumentAttachmentId;
// Document.
public $Document;
// Attachment description.
public $Description;
// Attachment data.
public $AttachmentData;
// Attachment name for file.
public $FileName;
// Attachment mime type.
public $MimeType;
// Entry date.
public $EntryDate;
public $RecordDtModified;
// Row version is used for concurrency check.
// Ignored on create request.
public $RowVersion;
}
/// Link with id, name and url to related data.
class mMApiFkField
{
// Record id.
public $ID;
// Record name.
public $Name;
// Url to full record details.
public $ResourceUrl;
}
This method returns result of type 'SAOP.API.Models.Document.DocumentAttachment'.
/// Document attachment details.
public class DocumentAttachment
{
// Document attachment id.
// Ignored on create request.
public Long DocumentAttachmentId;
// Document.
public mMApiFkField Document;
// Attachment description.
public String Description;
// Attachment data.
public String AttachmentData;
// Attachment name for file.
public String FileName;
// Attachment mime type.
public String MimeType;
// Entry date.
public Date EntryDate;
public Date RecordDtModified;
// Row version is used for concurrency check.
// Ignored on create request.
public String RowVersion;
}
/// Link with id, name and url to related data.
public class mMApiFkField
{
// Record id.
public Long ID;
// Record name.
public String Name;
// Url to full record details.
public String ResourceUrl;
}