Versions Compared

Key

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

Overview

This data type includes the detailed information on a document. A document can be a workspace attachment, project issue attachment, receipt, payment voucher attachment, uploaded invoice or a resource resume.Note that this structure contains various metadata about the document, but not the document itself.

Format

Panel
titlePwsDocument
  • PwsDocument
    • DocumentRefId: Int32
    • DocumentRefUid: Int64
    • CreatedByUserIdentity: PwsUserRef
    • CreatedTimestamp: DateTime
    • CurrentVersion: PwsDocumentVersion
    • DeletedByUserIdentity: PwsUserRef
    • DeletedTimestamp: DateTime
    • DocumentName: String (260)
    • DocumentSize: Int64
    • DocumentUri: String (2000)
    • LockedByUserIdentity: PwsUserRef
    • LockedTimestamp: DateTime
    • MimeType: String (128)
    • ModifiedByUserIdentity: PwsUserRef
    • ModifiedTimestamp: DateTime
    • SupportPreviewFlag: Boolean
    • SupportThumbnailFlag: Boolean
    • DocumentData: PwsDocumentDataElement
    • EditDeleteFlag: Boolean
    • NumberPages: Int16
    • ArchiveIdentity: PwsDocumentArchiveRef
    • EditDeletePermissionFlag: Boolean
    • ReceiptLockedFlag: Boolean

Elements

Element

Data Type

Description

Sample Data

DocumentRefId

Int32

 

 

 

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


DocumentRefUid

Int64

 

 

The document ref Uid is a unique identifier for a document.

1152921504607634579

CreatedByUserIdentity

PwsUserRef

 

 

The user that created this document. Click here for more information.


CreatedTimestamp

DateTime

 

 

The date time when this document was created.

2018-02-05T20:23:46.55Z

CurrentVersion

PwsDocumentVersion

 

 

The current version of this document. Click here for more information.


DeletedByUserIdentity

PwsUserRef

 

 

The user that deleted this document. Click here for more information.


DeletedTimestamp

DateTime

 

The date time when this document was deleted.

2018-02-06T21:33:21.11Z

DocumentName

String

 

 

(260)

The name of the document.

CFS poster.jpg

DocumentSize

Int64

 

 

The size of the document in bytes.

92531

DocumentUri

String

 

 

(2000)

The URL of the document. This applies only for links. Links are not supported for all document types.


LockedByUserIdentity

PwsUserRef

 

 

 

The user that has this documented locked. Click here for more information.


LockedTimestamp

DateTime

 

The date time when this document was locked.


MimeType

String

 

  

(128)

The file mime type of this document.

image/jpeg

ModifiedByUserIdentity

PwsUserRef

 

 

The user that last modified this document. Click here for more information.


ModifiedTimestamp

DateTime

 

 

The date time when this document was modified.

2018-02-06T21:33:21.11Z

SupportPreviewFlag

Boolean

 

If set to 'true', this document can be previewed.

true

SupportThumbnailFlag

Boolean

 

 

DocumentData

PwsDocumentDataElement

 

 

EditDeleteFlag

Boolean

 

 

NumberPages

Int16

 

 

ArchiveIdentity

PwsDocumentArchiveRef

 

 

EditDeletePermissionFlag

Boolean

 

 

ReceiptLockedFlag

Boolean

 

 

...

If set to 'true', this document can support thumbnail display.

true

DocumentData

PwsDocumentDataElement

The data about the document. The nature of the data will depend upon the document type. Currently, only receipts have DocumentData associated with them, and the data will include basic information about the cost cards, if any, to which the receipt is attached. Click here for more information.


EditDeleteFlag

Boolean

If set to 'true', requesting user has permission to edit or delete the document and the receipt is not locked if the document is a receipt.

true

NumberPages

Int16

The number of pages in this document.

3

ArchiveIdentity

PwsDocumentArchiveRef

This element is null unless the document has been archived and the archive has been downloaded (accepted). Click here for more information.


EditDeletePermissionFlag

Boolean

If set to 'true', requesting user has permission to edit or delete the document.

true

ReceiptLockedFlag

Boolean

Applies to a receipt document. If set to 'true', this document is locked and cannot be edited.

false


Usage Example(s)


Code Block
languagexml
titleExample 01- Receipt on a cost card
collapsetrue
            <a:Document>
               <DocumentRefId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
               <DocumentRefUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607655224</DocumentRefUid>
               <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                  <b:UserDisplayName>Bruce Wayne</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>BW-01</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606950320</b:UserUid>
               </a:CreatedByUserIdentity>
               <a:CreatedTimestamp>2018-03-19T14:42:05.167Z</a:CreatedTimestamp>
               <a:CurrentVersion>
                  <DocumentVersionId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <DocumentVersionUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607659447</DocumentVersionUid>
                  <a:Comments i:nil="true"/>
                  <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>Bruce Wayne</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>BW-01</b:UserReferenceSystemId>
                     <b:UserUid>1152921504606950320</b:UserUid>
                  </a:CreatedByUserIdentity>
                  <a:CreatedTimestamp>2018-03-19T14:42:05.167Z</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>Receipt on CC.jpg</a:DocumentName>
               <a:DocumentSize>72403</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>Bruce Wayne</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>BW-01</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606950320</b:UserUid>
               </a:ModifiedByUserIdentity>
               <a:ModifiedTimestamp>2018-03-19T14:42:05.167Z</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>1152921504614018558</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>Mar  1 2018</b:Value>
                                 <b:Values/>
                              </b:PwsValue>
                              <b:PwsValue>
                                 <b:ColumnType>V</b:ColumnType>
                                 <b:Tag>Expense Type</b:Tag>
                                 <b:Value>Personal Auto Mileage</b:Value>
                                 <b:Values/>
                              </b:PwsValue>
                              <b:PwsValue>
                                 <b:ColumnType>M</b:ColumnType>
                                 <b:Tag>Disbursed Amount</b:Tag>
                                 <b:Value>12.00</b:Value>
                                 <b:Values/>
                              </b:PwsValue>
                              <b:PwsValue>
                                 <b:ColumnType>V</b:ColumnType>
                                 <b:Tag>Disbursed Currency Code</b:Tag>
                                 <b:Value>CAD</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>1152921504607636703</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>1152921504614018558</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>Use the receipt on the left.</a:Notes>
                  </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:Document>      
Code Block
languagexml
titleExample 02- Receipt on an expense report
collapsetrue
            <a:Document>
               <DocumentRefId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
               <DocumentRefUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607655227</DocumentRefUid>
               <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                  <b:UserDisplayName>Bruce Wayne</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>BW-01</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606950320</b:UserUid>
               </a:CreatedByUserIdentity>
               <a:CreatedTimestamp>2018-03-19T14:44:09.65Z</a:CreatedTimestamp>
               <a:CurrentVersion>
                  <DocumentVersionId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <DocumentVersionUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607659450</DocumentVersionUid>
                  <a:Comments i:nil="true"/>
                  <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>Bruce Wayne</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>BW-01</b:UserReferenceSystemId>
                     <b:UserUid>1152921504606950320</b:UserUid>
                  </a:CreatedByUserIdentity>
                  <a:CreatedTimestamp>2018-03-19T14:44:09.65Z</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>Receipt on ER.jpg</a:DocumentName>
               <a:DocumentSize>24380</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>Bruce Wayne</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>BW-01</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606950320</b:UserUid>
               </a:ModifiedByUserIdentity>
               <a:ModifiedTimestamp>2018-03-19T14:44:09.65Z</a:ModifiedTimestamp>
               <a:SupportPreviewFlag>true</a:SupportPreviewFlag>
               <a:SupportThumbnailFlag>true</a:SupportThumbnailFlag>
               <a:DocumentData>
                  <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>1152921504607636703</b:ItemUid>
                        <b:ReferenceType i:nil="true"/>
                     </a:AssociatedItemIdentity>
                     <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:Document>      
Code Block
languagexml
titleExample 0103 - Resume
collapsetrue
            <a:Document>
               <DocumentRefId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
               <DocumentRefUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607634579<>1152921504607773797</DocumentRefUid>
               <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                  <b:UserDisplayName>BruceUserDisplayName>Krakauer, Wayne<Larry</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>BW-01<UserReferenceSystemId>097</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606950320<UserUid>1152921504606944254</b:UserUid>
               </a:CreatedByUserIdentity>
               <a:CreatedTimestamp>2018-0212-05T2013T19:2330:4631.55Z<22Z</a:CreatedTimestamp>
               <a:CurrentVersion>
                  <DocumentVersionId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <DocumentVersionUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607637642<>1152921504607778657</DocumentVersionUid>
                  <a:Comments i:nil="true"/>
                  <a:CreatedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>BruceUserDisplayName>Krakauer, Wayne<Larry</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>BW-01<UserReferenceSystemId>097</b:UserReferenceSystemId>
                     <b:UserUid>1152921504606950320<UserUid>1152921504606944254</b:UserUid>
                  </a:CreatedByUserIdentity>
                  <a:CreatedTimestamp>2018-0212-05T2013T19:2330:4631.55Z<22Z</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>CFSDocumentName>Barry Allen posterresume.jpg<docx</a:DocumentName>
               <a:DocumentSize>92531<DocumentSize>1577712</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<MimeType>application/vnd.openxmlformats-officedocument.wordprocessingml.document</a:MimeType>
               <a:ModifiedByUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                  <b:UserDisplayName>BruceUserDisplayName>Krakauer, Wayne<Larry</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>BW-01<UserReferenceSystemId>097</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606950320<UserUid>1152921504606944254</b:UserUid>
               </a:ModifiedByUserIdentity>
               <a:ModifiedTimestamp>2018-0212-05T2013T19:2330:4631.55Z<22Z</a:ModifiedTimestamp>
               <a:SupportPreviewFlag>true<SupportPreviewFlag>false</a:SupportPreviewFlag>
               <a:SupportThumbnailFlag>true<SupportThumbnailFlag>false</a:SupportThumbnailFlag>
               <a:DocumentData>
                  <a:DataItems/>
                  <a:DocumentDataDetail>
                     <a:AssociatedItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ItemId i:nil="true"/>
                        <b:ItemType i:nil="true"/>ItemType>R</b:ItemType>
                        <b:ItemUid>1152921504606875457<ItemUid>1152921504606962993</b:ItemUid>
                        <b:ReferenceType i:nil="true"/>
                     </a:AssociatedItemIdentity>
                     <a:Associations/>
                     <a:Notes i:nil="true"/>
                     <a:AssociatedItemDescription>Barry Franklin</a:AssociatedItemDescription>
                  </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:Document>