Package com.onshape.api.requests

Class MetadataUpdateStandardContentMetadataRequest.Builder

java.lang.Object

com.onshape.api.requests.MetadataUpdateStandardContentMetadataRequest.Builder

Enclosing class:

MetadataUpdateStandardContentMetadataRequest

public static final class MetadataUpdateStandardContentMetadataRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
MetadataUpdateStandardContentMetadataResponse	call(OnshapeDocument document, String pid, String vid, String oid)	Calls updateStandardContentMetadata method, Update metadata of a standard content part in a version for a specific user or company.
MetadataUpdateStandardContentMetadataResponse	call(String pid, String did, String vid, String eid, CU cuType, String oid)	Calls updateStandardContentMetadata method, Update metadata of a standard content part in a version for a specific user or company.
MetadataUpdateStandardContentMetadataRequestItems[]	items()	Get Collection of metadata object updates
MetadataUpdateStandardContentMetadataRequest.Builder	items(MetadataUpdateStandardContentMetadataRequestItems[] value)	Set Collection of metadata object updates
String	linkDocumentId()	Get Id of document that links to the document being accessed.
MetadataUpdateStandardContentMetadataRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

items

public final MetadataUpdateStandardContentMetadataRequestItems[] items()

Get Collection of metadata object updates

Returns:

Collection of metadata object updates

items

public final MetadataUpdateStandardContentMetadataRequest.Builder items(MetadataUpdateStandardContentMetadataRequestItems[] value)

Set Collection of metadata object updates

Parameters:

value - Collection of metadata object updates

Returns:

the Builder object.

linkDocumentId

public final String linkDocumentId()

Get Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Returns:

Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

linkDocumentId

public final MetadataUpdateStandardContentMetadataRequest.Builder linkDocumentId(String value)

Set Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Parameters:

value - Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Returns:

the Builder object.

call

public final MetadataUpdateStandardContentMetadataResponse call(String pid,
                                                                String did,
                                                                String vid,
                                                                String eid,
                                                                CU cuType,
                                                                String oid)
                                                         throws OnshapeException

Calls updateStandardContentMetadata method, Update metadata of a standard content part in a version for a specific user or company. Configuration information must be included within the items.*.href fields. The response format varies depending on whether there are multiple items to update.

Parameters:

pid - Part ID

did - Document ID

vid - Version ID

eid - Element ID

cuType - Type of Company or User

oid - Company (c) or User (u) ID of metadata owner

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final MetadataUpdateStandardContentMetadataResponse call(OnshapeDocument document,
                                                                String pid,
                                                                String vid,
                                                                String oid)
                                                         throws OnshapeException

Calls updateStandardContentMetadata method, Update metadata of a standard content part in a version for a specific user or company. Configuration information must be included within the items.*.href fields. The response format varies depending on whether there are multiple items to update.

Parameters:

document - Document object from Onshape URL.

pid - Part ID

vid - Version ID

oid - Company (c) or User (u) ID of metadata owner

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error