Document REST Endpoints
Documents are guidelines, procedures, standards, plans, design templates, worksheets, or other information related to a project. A document, or work product, can provide standards and guidelines for performing project work, or it can be formally identified as a project standard. Documents can be identified as project deliverables that will be given to the end user or customer at the end of the project. Documents can be assigned to activities and to work breakdown structure (WBS) elements. You can maintain general information about documents, such as revision date, location, and author. Documents are hierarchical objects.
The Document service supports user defined fields (UDFs). Use the UDFValue service to assign UDFs.
Note: This service provides create, read, update, and delete operations that apply to WP and Docs. You cannot assign external documents to an activity or WBS using this service.
- Checkin Document
- Method: postPath:
/document/checkinDocument
- Checkout Document
- Method: getPath:
/document/checkoutDocument
- Create Document
- Method: postPath:
/document
- Delete Document
- Method: deletePath:
/document
- Download Document
- Method: getPath:
/document/downloadDocument
- Read Document
- Method: getPath:
/document
- Update Document
- Method: putPath:
/document
- Upload Document
- Method: postPath:
/document/uploadDocument
- View Document Field Length
- Method: getPath:
/document/getFieldLength/{fieldName}
- View Document fields
- Method: getPath:
/document/fields