Change document properties
- Former user (Deleted)
Permits to modify document properties such as reference and version information.
URL
(PUT) projects/{projectid}/documents
PARAMETERS
token | The token obtained on connection | Required |
projectid | The project id | Required |
docid | Identifies the document to update by its id. The document id is the same for all language versions. | Optional |
name | Identifies the document to update by its path/name. The path/name is language independent. | Optional |
reference | Identifies the document to update by its reference. References are not necessarily unique. | Optional |
newreference | If specified then the document reference is updated. The reference is a user defined and optional document reference which can be used as an alternative user-defined document identifier. The system does not require this reference to be unique within a project. | Optional |
newversion | If specified then the document version string is updated. The version is user defined and optional. | Optional |
newversiondate | If specified then the optional document version date is updated. NOT YET IMPLEMENTED. | Optional |
RESULTS
A document is uniquely defined by both the "docid" and the "name". It is not required to set both.
However, the "reference" does not necessarily point to a single document. If the filter selects more than one document, the system will apply the changes to the first document only.Returns the ApiDocument item for the updated document.
Related content
Copyright Wordbee - Buzzin' Outside the Box since 2008