Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
titlePwsFolder
  • PwsFolder
    • FolderId: Int32
    • FolderUid: Int64
    • CreatedByUserIdentity: PwsUserRef
    • CreatedTimestamp: DateTime
    • DeletedByUserIdentity: PwsUserRef
    • DeletedTimestamp: DateTime
    • Documents: PwsDocument
    • FolderName: String
    • FolderTypeCode: String
    • ModifiedByUserIdentity: PwsUserRef
    • ModifiedTimestamp: DateTime
    • AttachmentNotes: PwsAttachmentNote
    • AssociatedEntityDescription: String
    • CanAddAssociationsFlag: Boolean
    • CanAddDocumentsFlag: Boolean
    • CanAddLinksFlag: Boolean
    • CanAddNotesFlag: Boolean
    • CanAddVersionsFlag: Boolean
    • CanDeleteDocumentsFlag: Boolean
    • CanSearchDocumentsFlag: Boolean
    • RequireDocumentDataFlag: Boolean
    • RequireUniqueFilenamesFlag: Boolean
    • UploadFolderIdentity: PwsFolderRef

...

Element

Data Type

Description

Sample Data

FolderId

Int32

The folder Id is a unique identifier for a folder. For internal use only.


FolderUid

Int64

The folder Uid is a unique and immutable identifier for a folder.

1152921504607349085

CreatedByUserIdentity

PwsUserRef

The user who created the folder.


CreatedTimestamp

DateTime

The date and time (in UTC format) this folder was created.

2018-03-16T16:07:37.2Z 

DeletedByUserIdentity

PwsUserRef

The user who deleted the folder.


DeletedTimestamp

DateTime

The date and time (in UTC format) this folder was deleted.


Documents

PwsDocument

The details of the document(s) within the folder.


FolderName

String

The folder name.

Expense report created 27 Feb 2018 - A

FolderTypeCode

String

The folder type code:

'ProjectWorkspaceFolder' for Project Workspace Folder. Project workspace documents are placed in a folder associated with the project.

'ResourceResumeFolder' for Resource Resume Folder. Resource resumes are placed in a folder associated with the resource.

'InvoiceFolder' for Invoice Folder. Invoices uploaded to the workspace are placed in an invoice folder associated with the Projector Invoice.

'ProjectIssueFolder' for Project Issue Folder. Attachments to a project issue are placed in a folder associated with the project issue.

'ExpenseReportFolder' for Expense Document Folder. Receipts attached to expense documents or cost cards are placed in a folder associated with the expense document (for cost card receipts, this is the expense document that contains the cost card).

'UserReceiptPoolFolder' for a User's Receipt Folder (see below)

'UserIssueAttachmentPoolFolder' for User's Issue Attachment Pool Folder (see below)

'PaymentVoucherFolder' for Payment Voucher Folder. Payment voucher attachments are placed in a folder associated with the payment voucher.

ExpenseReportFolder

ModifiedByUserIdentity

PwsUserRef

The user who last modified the folder.


ModifiedTimestamp

DateTime

The date and time (in UTC format) this folder was last modified.

2018-03-16T16:07:37.2Z

AttachmentNotes

PwsAttachmentNote

The receipt notes that are contained in this folder. Notes associated with uploaded receipts are returned along with the information about the receipt (in the Documents list). This list only contains receipt notes that do not have an accompanying receipt document.


AssociatedEntityDescriptionString

CanAddAssociationsFlag

Boolean

If set to 'true', the document folder allows for associations.

true

CanAddDocumentsFlag

Boolean

If set to 'true', documents can be added to the folder.

true 

CanAddLinksFlag

Boolean

If set to 'true', URL links can be added to the folder.

false

CanAddNotesFlag

Boolean

If set to 'true', notes can be added to the folder.

true 

CanAddVersionsFlag

Boolean

If set to 'true', document versions can be added to the folder.

false
CanDeleteDocumentsFlagBooleanIf set to 'true', document can be deleted from this folder.true

CanSearchDocumentsFlag

Boolean

If set to 'true', document searches can be executed within the folder.

false 

RequireDocumentDataFlag

Boolean

If set to 'true', this folder type required Document Data for each of the contained documents.

true 

RequireUniqueFilenamesFlag

Boolean

If set to 'true', file names within the folder must be unique

false 

UploadFolderIdentity

PwsFolderRef

For internal use.


...