Package com.onshape.api.requests

Class DocumentsShareDocumentRequestEntries

java.lang.Object

com.onshape.api.requests.DocumentsShareDocumentRequestEntries

public final class DocumentsShareDocumentRequestEntries
extends Object

Object used in calls to shareDocument API endpoint. © 2018-Present Onshape Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentsShareDocumentRequestEntries.Builder

Field Summary

Fields

Modifier and Type	Field	Description
String	applicationId	The ID of an Onshape Application to share with.
String	companyId	The ID of an Onshape Company to share with
String	email	The email of a user to share with.
String	entryType	The type of entity that whe are sharing with.
String	teamId	The ID of an Onshape Team to share with
String	userId	The ID of an Onshape User to share with

Method Summary

Modifier and Type	Method	Description
static DocumentsShareDocumentRequestEntries.Builder	builder()
String	getApplicationId()	Get The ID of an Onshape Application to share with.
String	getCompanyId()	Get The ID of an Onshape Company to share with
String	getEmail()	Get The email of a user to share with.
String	getEntryType()	Get The type of entity that whe are sharing with.
String	getTeamId()	Get The ID of an Onshape Team to share with
String	getUserId()	Get The ID of an Onshape User to share with
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

companyId

public String companyId

The ID of an Onshape Company to share with

email

public String email

The email of a user to share with. If the email is not associated with an existing Onshape user, an invite email will be sent to the email address if update=false, otherwise the response will be a NOT FOUND error.

teamId

public String teamId

The ID of an Onshape Team to share with

userId

public String userId

The ID of an Onshape User to share with

applicationId

public String applicationId

The ID of an Onshape Application to share with. Note that application sharing only allows READ to be specified as a permission.

entryType

public String entryType

The type of entity that whe are sharing with. Valid values are 0=User (specify userId or email), 1=Company, 2=Team, 4=Application. Must correspond to the id field populated.

Method Detail

getCompanyId

public final String getCompanyId()

Get The ID of an Onshape Company to share with

Returns:

The ID of an Onshape Company to share with

getEmail

public final String getEmail()

Get The email of a user to share with. If the email is not associated with an existing Onshape user, an invite email will be sent to the email address if update=false, otherwise the response will be a NOT FOUND error.

Returns:

The email of a user to share with. If the email is not associated with an existing Onshape user, an invite email will be sent to the email address if update=false, otherwise the response will be a NOT FOUND error.

getTeamId

public final String getTeamId()

Get The ID of an Onshape Team to share with

Returns:

The ID of an Onshape Team to share with

getUserId

public final String getUserId()

Get The ID of an Onshape User to share with

Returns:

The ID of an Onshape User to share with

getApplicationId

public final String getApplicationId()

Get The ID of an Onshape Application to share with. Note that application sharing only allows READ to be specified as a permission.

Returns:

The ID of an Onshape Application to share with. Note that application sharing only allows READ to be specified as a permission.

getEntryType

public final String getEntryType()

Get The type of entity that whe are sharing with. Valid values are 0=User (specify userId or email), 1=Company, 2=Team, 4=Application. Must correspond to the id field populated.

Returns:

The type of entity that whe are sharing with. Valid values are 0=User (specify userId or email), 1=Company, 2=Team, 4=Application. Must correspond to the id field populated.

builder

public static final DocumentsShareDocumentRequestEntries.Builder builder()

toString

public String toString()

Overrides:

toString in class Object