latestOpenAPI 3.0.1Apache 2.02026-08-133021,2261.8 MB

aaa3e1322450

Metadata

Update the metadata for a part.

See API Guide: Metadata for details.

  • Specify the part in the iden or pid path parameter.
  • The configuration optional query parameter uses the default configuration unless otherwise specified.
  • linkDocumentId can be specified where applicable. Combined with inferMetadataOwner (default value is false), this is used to infer metadata owner.
  • Specify the property metadata to update in the Request body.
post/metadata/d/{did}/{wvm}/{wvmid}/e/{eid}/{iden}/{pid}

Path parameters

didstring required

The id of the document in which to perform the operation.

wvm'w' | 'v' | 'm' required

Indicates which of workspace (w), version (v), or document microversion (m) id is specified below.

wvmidstring required

The id of the workspace, version or document microversion in which the operation should be performed.

eidstring required

The id of the element in which to perform the operation.

iden'p' | 'pi' required

Denotes whether the pid specified is a part id (p) or a part identity (pi).

pidstring required

Query parameters

linkDocumentIdstring

The id of the document through which the above document should be accessed; only applicable when accessing a version of the document. This allows a user who has access to document a to see data from document b, as long as document b has been linked to document a by a user who has permission to both.

configurationstring

URL-encoded string of configuration values (separated by ;). See the Configurations API Guide for details.

rollbackBarIndexinteger

Index specifying the location of the rollback bar when the call is evaluated. A -1 indicates that it should be at the end of the featurelist.

elementMicroversionIdstring

A specific element microversion in which to evaluate the request.

Response

default response