1Share Entity

Content-Type (Required)

String

Specifies media type of request body.

application/x-www-form-urlencoded

sessionid

String

The session ID is the token received from the login API.

Note: Session ID is required for token-based authentication.

–

name-or-id (Required)

String

Name or ID of the entity to be shared.

Note: If the entity name is provided, then either folderName or folderId must also be provided.

–

by

String

Specifies whether the name-or-id parameter should be interpreted as an entity name or entity ID.

If by=name, provide the entity name in the name-or-id parameter.

If by=id, provide the entity ID in the name-or-id parameter.

The default value is name.

–

type (Required)

String

Type of entity that needs to be shared.

RDATASET, RELATIONSHIP, SMODEL, CONNECTION, SPACE, WORKSHEET, WORKBOOK

folderName

String

Name of the folder that contains the entity. If the entity is present in the root directory, specify [Root].

Note: If neither folderName nor folderId is provided, the entity will be treated as a root-level entity by default.

–

folderId

String

ID of the folder that contains the entity.

–

assigneeName

String

Name of the user or group with whom the entity needs to be shared.

–

assigneeType

String

Type of assignee with whom the entity needs to be shared.

USER, GROUP

grant

String

Type of access permission that needs to be assigned.

READ_ONLY, READ_WRITE, DENY

workbookName

String

Name of the Workbook that contains the Worksheet.

Note: Either workbookName or workbookId is required when type=WORKSHEET and the Worksheet name is provided in the name-or-id path parameter.

–

workbookId

String

ID of the Workbook that contains the Worksheet.

–

401

Authorization information is missing or invalid.

404

Connection, database, schema, or table not found.

412

Precondition failed. Parameter missing.

500

Internal Server Error.