Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionDeletes a document property.
 

Doctypeaddon-componenthide
NameProperty Service / DELETE
 

Short NameDELETE
 

Parent
Parent Property
property-nameName
 

Audience
Name List
render-no-hits-as-blanktrue
addon-componentrole
propertyAudience
 

Type

Name List
doctypeaddon-component-type
render-no-hits-as-blanktrue
namesREST Method
propertyType

 


Subject
Name List
doctypesubject
propertySubject
 

Categories
Name List
doctypecategory
propertyCategories
 

Tags
Tag List
propertyTags
 

Iteration

Iteration
value

filled

finished

hide
ExtensionWeb API Extension
Since1.1
 

Path
Parent Property
add-linkfalse
propertyPath
property-namePath
 

Deprecatedhide
Removedhide
Sort Key00300hide
Section
indextrue
show-titlefalse
titleDescription

Deletes a document property.

There is no undo! It is strongly recommended to run commands only on backed up instances. Make a backup of your data before starting to work with this API! Consider to run your experiments on a copy of the production data!
projectdoc-boxtransclusion-warningmacro
documentPlease Backup your Data first!
idsSummary

If your environment does not support the HTTP PATCH method try to use the patch resource at projectdoc/1/patch/document/{id}/property/{name} as a workaround.

Section
titlePath Parameter

All path parameters are required to be specified.

Section
titlename

The name of the requested property.

Section
titleid

The unique identifier of the requested projectdoc document.

Section
titlenew-version

 Flag to control whether a new version should be created. If set to false, the document is saved without creating a new version. Defaults to true to create a new version.

The parameter is available since version 1.2.

Section
titlenamecomment

 The optional comment for the version. If no new version is created, the current comment is overridden.

The parameter is available since version 1.2The name of the requested property.

Section
titleSubordinate Components
Display Table
doctypeaddon-component
render-no-hits-as-blanktrue
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...