Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Overview


This structure represents the fields associated with a document folder including its contents

Format


PwsFolder
  • 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 [???]
    • CanAddAssociationsFlag: Boolean
    • CanAddDocumentsFlag: Boolean
    • CanAddLinksFlag: Boolean
    • CanAddNotesFlag: Boolean
    • CanAddVersionsFlag: Boolean
    • CanSearchDocumentsFlag: Boolean
    • RequireDocumentDataFlag: Boolean
    • RequireUniqueFilenamesFlag: Boolean
    • UploadFolderIdentity: PwsFolderRef

Elements


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

'ResourceResumeFolder' for Resource Resume Folder

'InvoiceFolder' for Invoice Folder

'ProjectIssueFolder' for Project Issue Folder

'ExpenseReportFolder' for Expense Report Folder

'UserReceiptPoolFolder' for a User's Receipt Folder

'UserIssueAttachmentPoolFolder' for User's Issue Attachment Pool Folder

'PaymentVoucherFolder' for Payment Voucher Folder

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


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

CanSearchDocumentsFlag

Boolean

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

false 

RequireDocumentDataFlag

Boolean

 ???

true 

RequireUniqueFilenamesFlag

Boolean

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

false 

UploadFolderIdentity

PwsFolderRef

 ???


Usage Example(s)


Example 01
             <a:Folder>
               <FolderId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
               <FolderUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607349085</FolderUid>
               <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                  <b:UserDisplayName>Beth Brown</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>E125</b:UserReferenceSystemId>
                  <b:UserUid>1152921504607011056</b:UserUid>
               </a:CreatedByUserIdentity>
               <a:CreatedTimestamp>2018-03-16T16:07:37.2Z</a:CreatedTimestamp>
               <a:DeletedByUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
               <a:DeletedTimestamp i:nil="true"/>
               <a:Documents>
                  <a:PwsDocument>
                     <DocumentRefId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <DocumentRefUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607571587</DocumentRefUid>
                     <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:UserDisplayName>Beth Brown</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>E125</b:UserReferenceSystemId>
                        <b:UserUid>1152921504607011056</b:UserUid>
                     </a:CreatedByUserIdentity>
                     <a:CreatedTimestamp>2018-03-16T16:07:33.117Z</a:CreatedTimestamp>
                     <a:CurrentVersion>
                        <DocumentVersionId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <DocumentVersionUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607572684</DocumentVersionUid>
                        <a:Comments i:nil="true"/>
                        <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:UserDisplayName>Beth Brown</b:UserDisplayName>
                           <b:UserId i:nil="true"/>
                           <b:UserReferenceSystemId>E125</b:UserReferenceSystemId>
                           <b:UserUid>1152921504607011056</b:UserUid>
                        </a:CreatedByUserIdentity>
                        <a:CreatedTimestamp>2018-03-16T16:07:33.117Z</a:CreatedTimestamp>
                        <a:DocumentArchiveIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <a:VersionNumber>1</a:VersionNumber>
                     </a:CurrentVersion>
                     <a:DeletedByUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <a:DeletedTimestamp i:nil="true"/>
                     <a:DocumentName>01_Scan_1.jpeg</a:DocumentName>
                     <a:DocumentSize>28613</a:DocumentSize>
                     <a:DocumentUri i:nil="true"/>
                     <a:LockedByUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <a:LockedTimestamp i:nil="true"/>
                     <a:MimeType>image/jpeg</a:MimeType>
                     <a:ModifiedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:UserDisplayName>Beth Brown</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>E125</b:UserReferenceSystemId>
                        <b:UserUid>1152921504607011056</b:UserUid>
                     </a:ModifiedByUserIdentity>
                     <a:ModifiedTimestamp>2018-03-16T16:07:33.117Z</a:ModifiedTimestamp>
                     <a:SupportPreviewFlag>true</a:SupportPreviewFlag>
                     <a:SupportThumbnailFlag>true</a:SupportThumbnailFlag>
                     <a:DocumentData>
                        <a:DataItems>
                           <a:PwsDocumentDataItems>
                              <a:AssociatedItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                                 <b:ItemId i:nil="true"/>
                                 <b:ItemType>CCD</b:ItemType>
                                 <b:ItemUid>1152921504614515297</b:ItemUid>
                                 <b:ReferenceType i:nil="true"/>
                              </a:AssociatedItemIdentity>
                              <a:Data>
                                 <a:Values xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                                    <b:PwsValue>
                                       <b:ColumnType>V</b:ColumnType>
                                       <b:Tag>Type</b:Tag>
                                       <b:Value>CostCard</b:Value>
                                       <b:Values/>
                                    </b:PwsValue>
                                    <b:PwsValue>
                                       <b:ColumnType>D</b:ColumnType>
                                       <b:Tag>Incurred Date</b:Tag>
                                       <b:Value>Feb 27 2018</b:Value>
                                       <b:Values/>
                                    </b:PwsValue>
                                    <b:PwsValue>
                                       <b:ColumnType>V</b:ColumnType>
                                       <b:Tag>Expense Type</b:Tag>
                                       <b:Value>Other/Misc Billable</b:Value>
                                       <b:Values/>
                                    </b:PwsValue>
                                    <b:PwsValue>
                                       <b:ColumnType>M</b:ColumnType>
                                       <b:Tag>Disbursed Amount</b:Tag>
                                       <b:Value>21.75</b:Value>
                                       <b:Values/>
                                    </b:PwsValue>
                                    <b:PwsValue>
                                       <b:ColumnType>V</b:ColumnType>
                                       <b:Tag>Disbursed Currency Code</b:Tag>
                                       <b:Value>USD</b:Value>
                                       <b:Values/>
                                    </b:PwsValue>
                                 </a:Values>
                              </a:Data>
                           </a:PwsDocumentDataItems>
                        </a:DataItems>
                        <a:DocumentDataDetail>
                           <a:AssociatedItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                              <b:ItemId i:nil="true"/>
                              <b:ItemType>ED</b:ItemType>
                              <b:ItemUid>1152921504607683575</b:ItemUid>
                              <b:ReferenceType i:nil="true"/>
                           </a:AssociatedItemIdentity>
                           <a:Associations>
                              <a:PwsDocumentAssociation>
                                 <a:AssociatedItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                                    <b:ItemId i:nil="true"/>
                                    <b:ItemType>CCD</b:ItemType>
                                    <b:ItemUid>1152921504614515297</b:ItemUid>
                                    <b:ReferenceType i:nil="true"/>
                                 </a:AssociatedItemIdentity>
                                 <a:ReferenceNumber i:nil="true"/>
                                 <a:ReferenceNumberClearFlag>false</a:ReferenceNumberClearFlag>
                              </a:PwsDocumentAssociation>
                           </a:Associations>
                           <a:Notes i:nil="true"/>
                        </a:DocumentDataDetail>
                     </a:DocumentData>
                     <a:EditDeleteFlag>true</a:EditDeleteFlag>
                     <a:NumberPages i:nil="true"/>
                     <a:ArchiveIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <a:EditDeletePermissionFlag>true</a:EditDeletePermissionFlag>
                     <a:ReceiptLockedFlag>false</a:ReceiptLockedFlag>
                  </a:PwsDocument>
               </a:Documents>
               <a:FolderName>Expense report created 27 Feb 2018 - A</a:FolderName>
               <a:FolderTypeCode>ExpenseReportFolder</a:FolderTypeCode>
               <a:ModifiedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                  <b:UserDisplayName>Beth Brown</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>E125</b:UserReferenceSystemId>
                  <b:UserUid>1152921504607011056</b:UserUid>
               </a:ModifiedByUserIdentity>
               <a:ModifiedTimestamp>2018-03-16T16:07:37.2Z</a:ModifiedTimestamp>
               <a:AttachmentNotes>
                  <a:PwsAttachmentNote>
                     <AttachmentNoteId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <AttachmentNoteUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607351899</AttachmentNoteUid>
                     <a:DocumentData>
                        <a:DataItems>
                           <a:PwsDocumentDataItems>
                              <a:AssociatedItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                                 <b:ItemId i:nil="true"/>
                                 <b:ItemType>CCD</b:ItemType>
                                 <b:ItemUid>1152921504614515296</b:ItemUid>
                                 <b:ReferenceType i:nil="true"/>
                              </a:AssociatedItemIdentity>
                              <a:Data>
                                 <a:Values xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                                    <b:PwsValue>
                                       <b:ColumnType>V</b:ColumnType>
                                       <b:Tag>Type</b:Tag>
                                       <b:Value>CostCard</b:Value>
                                       <b:Values/>
                                    </b:PwsValue>
                                    <b:PwsValue>
                                       <b:ColumnType>D</b:ColumnType>
                                       <b:Tag>Incurred Date</b:Tag>
                                       <b:Value>Feb 27 2018</b:Value>
                                       <b:Values/>
                                    </b:PwsValue>
                                    <b:PwsValue>
                                       <b:ColumnType>V</b:ColumnType>
                                       <b:Tag>Expense Type</b:Tag>
                                       <b:Value>Travel</b:Value>
                                       <b:Values/>
                                    </b:PwsValue>
                                    <b:PwsValue>
                                       <b:ColumnType>M</b:ColumnType>
                                       <b:Tag>Disbursed Amount</b:Tag>
                                       <b:Value>500.00</b:Value>
                                       <b:Values/>
                                    </b:PwsValue>
                                    <b:PwsValue>
                                       <b:ColumnType>V</b:ColumnType>
                                       <b:Tag>Disbursed Currency Code</b:Tag>
                                       <b:Value>USD</b:Value>
                                       <b:Values/>
                                    </b:PwsValue>
                                 </a:Values>
                              </a:Data>
                           </a:PwsDocumentDataItems>
                        </a:DataItems>
                        <a:DocumentDataDetail>
                           <a:AssociatedItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                              <b:ItemId i:nil="true"/>
                              <b:ItemType>ED</b:ItemType>
                              <b:ItemUid>1152921504607683575</b:ItemUid>
                              <b:ReferenceType i:nil="true"/>
                           </a:AssociatedItemIdentity>
                           <a:Associations>
                              <a:PwsDocumentAssociation>
                                 <a:AssociatedItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                                    <b:ItemId i:nil="true"/>
                                    <b:ItemType>CCD</b:ItemType>
                                    <b:ItemUid>1152921504614515296</b:ItemUid>
                                    <b:ReferenceType i:nil="true"/>
                                 </a:AssociatedItemIdentity>
                                 <a:ReferenceNumber i:nil="true"/>
                                 <a:ReferenceNumberClearFlag>false</a:ReferenceNumberClearFlag>
                              </a:PwsDocumentAssociation>
                           </a:Associations>
                           <a:Notes>This receipt was lost, a copy has been requested.</a:Notes>
                        </a:DocumentDataDetail>
                     </a:DocumentData>
                     <a:EditDeleteFlag>true</a:EditDeleteFlag>
                     <a:EditDeletePermissionFlag>true</a:EditDeletePermissionFlag>
                     <a:ReceiptLockedFlag>false</a:ReceiptLockedFlag>
                  </a:PwsAttachmentNote>
               </a:AttachmentNotes>
               <a:CanAddAssociationsFlag>true</a:CanAddAssociationsFlag>
               <a:CanAddDocumentsFlag>true</a:CanAddDocumentsFlag>
               <a:CanAddLinksFlag>false</a:CanAddLinksFlag>
               <a:CanAddNotesFlag>true</a:CanAddNotesFlag>
               <a:CanAddVersionsFlag>false</a:CanAddVersionsFlag>
               <a:CanSearchDocumentsFlag>false</a:CanSearchDocumentsFlag>
               <a:RequireDocumentDataFlag>true</a:RequireDocumentDataFlag>
               <a:RequireUniqueFilenamesFlag>false</a:RequireUniqueFilenamesFlag>
               <a:UploadFolderIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                  <b:FolderId i:nil="true"/>
                  <b:FolderUid>1152921504607349076</b:FolderUid>
               </a:UploadFolderIdentity>
            </a:Folder>
  • No labels