Delete Project Document

/api/ProjectDocument/DeleteProjectDocument

Query String

ParameterRequiredValue
pinProjectIdMandatory<PINProjectID>

Request Header

ParameterRequiredValue
TokenKeyMandatoryUser Input
Accept-LanguageOptionalen-US
Accept-EncodingOptionalgzip
Content-TypeMandatoryapplication/json

Request Body

ParameterRequiredValue
  • ProjectDocument
MandatoryProjectFolderID, ProjectDocumentID, Filesize

Sample Body

[
  {
    "ProjectFolderID": "<ProjectFolderID>",
    "ProjectDocumentID": "<ProjectDocumentID>",
    "Filesize": "<Filesize>"
  },
  {
    "ProjectFolderID": "<ProjectFolderID>",
    "ProjectDocumentID": "<ProjectDocumentID>",
    "Filesize": "<Filesize>"
  },
  {
    "ProjectFolderID": "<ProjectFolderID>",
    "ProjectDocumentID": "<ProjectDocumentID>",
    "Filesize": "<Filesize>"
  }
]

Entity : Project Document

Property NameDescription
ProjectFolderIDInteger
PINProjectIDInteger
ProjectDocumentIDInteger
CurrentCheckOutStatusInteger
DocumentTitleString
DocumentNameString
SearchTagString
OriginalFileNameString
OriginalExtensionString
FilesizeString (in bytes)
UploadStatusByte [Nullable]
RevisionDateDateTime [Nullable]
RevisionNumberInteger [Nullable]
RevisionRemarksString
RevisedByUser
UploadUrlString
CheckedByUser
ExpiryDateDateTime [Nullable]
ShareLinkString
IsMarkupExistsBoolean
MarkupCountInteger [Nullable]
PathNameString
PathFolderIDString
PermissionPermission
DownloadString
AWSDownloadString
ViewString
StorageIDInteger
CustomPropertiesIEnumerable<CustomProperty>

Remarks

  1. FileSize is in bytes.

  2. Response header parameter Failed–Deletion will contain those document ids which are not deleted.