Document REST Endpoints

Sort by

Task Path Method

Document

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.

Create Document

Method: post

Path: /document

Delete Document

Method: delete

Path: /document

Read Document

Method: get

Path: /document

Update Document

Method: put

Path: /document

View Document Field Length

Method: get

Path: /document/getFieldLength/{fieldName}

View Document fields

Method: get

Path: /document/fields