\DrivesRootApi

All URIs are relative to https://ocis.ocis.rolling.owncloud.works/graph

Method	HTTP request	Description
CreateDriveItem	Post /v1beta1/drives/{drive-id}/root/children	Create a drive item
CreateLinkSpaceRoot	Post /v1beta1/drives/{drive-id}/root/createLink	Create a sharing link for the root item of a Drive
DeletePermissionSpaceRoot	Delete /v1beta1/drives/{drive-id}/root/permissions/{perm-id}	Remove access to a Drive
GetPermissionSpaceRoot	Get /v1beta1/drives/{drive-id}/root/permissions/{perm-id}	Get a single sharing permission for the root item of a drive
GetRoot	Get /v1.0/drives/{drive-id}/root	Get root from arbitrary space
InviteSpaceRoot	Post /v1beta1/drives/{drive-id}/root/invite	Send a sharing invitation
ListPermissionsSpaceRoot	Get /v1beta1/drives/{drive-id}/root/permissions	List the effective permissions on the root item of a drive.
SetPermissionPasswordSpaceRoot	Post /v1beta1/drives/{drive-id}/root/permissions/{perm-id}/setPassword	Set sharing link password for the root item of a drive
UpdatePermissionSpaceRoot	Patch /v1beta1/drives/{drive-id}/root/permissions/{perm-id}	Update sharing permission

CreateDriveItem

DriveItem CreateDriveItem(ctx, driveId).DriveItem(driveItem).Execute()

Create a drive item

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/owncloud/libre-graph-api-go"
)

func main() {
	driveId := "a0ca6a90-a365-4782-871e-d44447bbc668$a0ca6a90-a365-4782-871e-d44447bbc668" // string | key: id of drive
	driveItem := *openapiclient.NewDriveItem() // DriveItem | In the request body, provide a JSON object with the following parameters. For mounting a share the necessary remoteItem id and permission id can be taken from the [sharedWithMe](#/me.drive/ListSharedWithMe) endpoint. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DrivesRootApi.CreateDriveItem(context.Background(), driveId).DriveItem(driveItem).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DrivesRootApi.CreateDriveItem``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateDriveItem`: DriveItem
	fmt.Fprintf(os.Stdout, "Response from `DrivesRootApi.CreateDriveItem`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
driveId	string	key: id of drive

Other Parameters

Other parameters are passed through a pointer to a apiCreateDriveItemRequest struct via the builder pattern

Name	Type	Description	Notes

driveItem | DriveItem | In the request body, provide a JSON object with the following parameters. For mounting a share the necessary remoteItem id and permission id can be taken from the sharedWithMe endpoint. |

Return type

DriveItem

Authorization

openId, basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateLinkSpaceRoot

Permission CreateLinkSpaceRoot(ctx, driveId).DriveItemCreateLink(driveItemCreateLink).Execute()

Create a sharing link for the root item of a Drive

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/owncloud/libre-graph-api-go"
)

func main() {
	driveId := "driveId_example" // string | key: id of drive
	driveItemCreateLink := *openapiclient.NewDriveItemCreateLink() // DriveItemCreateLink | In the request body, provide a JSON object with the following parameters. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DrivesRootApi.CreateLinkSpaceRoot(context.Background(), driveId).DriveItemCreateLink(driveItemCreateLink).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DrivesRootApi.CreateLinkSpaceRoot``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateLinkSpaceRoot`: Permission
	fmt.Fprintf(os.Stdout, "Response from `DrivesRootApi.CreateLinkSpaceRoot`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
driveId	string	key: id of drive

Other Parameters

Other parameters are passed through a pointer to a apiCreateLinkSpaceRootRequest struct via the builder pattern

Name	Type	Description	Notes

driveItemCreateLink | DriveItemCreateLink | In the request body, provide a JSON object with the following parameters. |

Return type

Permission

Authorization

openId, basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeletePermissionSpaceRoot

DeletePermissionSpaceRoot(ctx, driveId, permId).Execute()

Remove access to a Drive

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/owncloud/libre-graph-api-go"
)

func main() {
	driveId := "driveId_example" // string | key: id of drive
	permId := "permId_example" // string | key: id of permission

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.DrivesRootApi.DeletePermissionSpaceRoot(context.Background(), driveId, permId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DrivesRootApi.DeletePermissionSpaceRoot``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
driveId	string	key: id of drive
permId	string	key: id of permission

Other Parameters

Other parameters are passed through a pointer to a apiDeletePermissionSpaceRootRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

openId, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPermissionSpaceRoot

Permission GetPermissionSpaceRoot(ctx, driveId, permId).Execute()

Get a single sharing permission for the root item of a drive

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/owncloud/libre-graph-api-go"
)

func main() {
	driveId := "driveId_example" // string | key: id of drive
	permId := "permId_example" // string | key: id of permission

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DrivesRootApi.GetPermissionSpaceRoot(context.Background(), driveId, permId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DrivesRootApi.GetPermissionSpaceRoot``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetPermissionSpaceRoot`: Permission
	fmt.Fprintf(os.Stdout, "Response from `DrivesRootApi.GetPermissionSpaceRoot`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
driveId	string	key: id of drive
permId	string	key: id of permission

Other Parameters

Other parameters are passed through a pointer to a apiGetPermissionSpaceRootRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Permission

Authorization

openId, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRoot

DriveItem GetRoot(ctx, driveId).Execute()

Get root from arbitrary space

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/owncloud/libre-graph-api-go"
)

func main() {
	driveId := "driveId_example" // string | key: id of drive

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DrivesRootApi.GetRoot(context.Background(), driveId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DrivesRootApi.GetRoot``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetRoot`: DriveItem
	fmt.Fprintf(os.Stdout, "Response from `DrivesRootApi.GetRoot`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
driveId	string	key: id of drive

Other Parameters

Other parameters are passed through a pointer to a apiGetRootRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

DriveItem

Authorization

openId, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

InviteSpaceRoot

CollectionOfPermissions InviteSpaceRoot(ctx, driveId).DriveItemInvite(driveItemInvite).Execute()

Send a sharing invitation

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/owncloud/libre-graph-api-go"
)

func main() {
	driveId := "driveId_example" // string | key: id of drive
	driveItemInvite := *openapiclient.NewDriveItemInvite() // DriveItemInvite | In the request body, provide a JSON object with the following parameters. To create a custom role submit a list of actions instead of roles. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DrivesRootApi.InviteSpaceRoot(context.Background(), driveId).DriveItemInvite(driveItemInvite).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DrivesRootApi.InviteSpaceRoot``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `InviteSpaceRoot`: CollectionOfPermissions
	fmt.Fprintf(os.Stdout, "Response from `DrivesRootApi.InviteSpaceRoot`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
driveId	string	key: id of drive

Other Parameters

Other parameters are passed through a pointer to a apiInviteSpaceRootRequest struct via the builder pattern

Name	Type	Description	Notes

driveItemInvite | DriveItemInvite | In the request body, provide a JSON object with the following parameters. To create a custom role submit a list of actions instead of roles. |

Return type

CollectionOfPermissions

Authorization

openId, basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListPermissionsSpaceRoot

CollectionOfPermissionsWithAllowedValues ListPermissionsSpaceRoot(ctx, driveId).Filter(filter).Select_(select_).Execute()

List the effective permissions on the root item of a drive.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/owncloud/libre-graph-api-go"
)

func main() {
	driveId := "driveId_example" // string | key: id of drive
	filter := "@libre.graph.permissions.roles.allowedValues/rolePermissions/any(p:contains(p/condition, '@Subject.UserType=="Federated"'))" // string | Filter items by property values. By default all permissions are returned and the avalable sharing roles are limited to normal users. To get a list of sharing roles applicable to federated users use the example $select query and combine it with $filter to omit the list of permissions. (optional)
	select_ := []string{"Select_example"} // []string | Select properties to be returned. By default all properties are returned. Select the roles property to fetch the available sharing roles without resolving all the permissions. Combine this with the $filter parameter to fetch the actions applicable to federated users. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DrivesRootApi.ListPermissionsSpaceRoot(context.Background(), driveId).Filter(filter).Select_(select_).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DrivesRootApi.ListPermissionsSpaceRoot``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListPermissionsSpaceRoot`: CollectionOfPermissionsWithAllowedValues
	fmt.Fprintf(os.Stdout, "Response from `DrivesRootApi.ListPermissionsSpaceRoot`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
driveId	string	key: id of drive

Other Parameters

Other parameters are passed through a pointer to a apiListPermissionsSpaceRootRequest struct via the builder pattern

Name	Type	Description	Notes

filter | string | Filter items by property values. By default all permissions are returned and the avalable sharing roles are limited to normal users. To get a list of sharing roles applicable to federated users use the example $select query and combine it with $filter to omit the list of permissions. | select_ | []string | Select properties to be returned. By default all properties are returned. Select the roles property to fetch the available sharing roles without resolving all the permissions. Combine this with the $filter parameter to fetch the actions applicable to federated users. |

Return type

CollectionOfPermissionsWithAllowedValues

Authorization

openId, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetPermissionPasswordSpaceRoot

Permission SetPermissionPasswordSpaceRoot(ctx, driveId, permId).SharingLinkPassword(sharingLinkPassword).Execute()

Set sharing link password for the root item of a drive

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/owncloud/libre-graph-api-go"
)

func main() {
	driveId := "driveId_example" // string | key: id of drive
	permId := "permId_example" // string | key: id of permission
	sharingLinkPassword := *openapiclient.NewSharingLinkPassword() // SharingLinkPassword | New password value

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DrivesRootApi.SetPermissionPasswordSpaceRoot(context.Background(), driveId, permId).SharingLinkPassword(sharingLinkPassword).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DrivesRootApi.SetPermissionPasswordSpaceRoot``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SetPermissionPasswordSpaceRoot`: Permission
	fmt.Fprintf(os.Stdout, "Response from `DrivesRootApi.SetPermissionPasswordSpaceRoot`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
driveId	string	key: id of drive
permId	string	key: id of permission

Other Parameters

Other parameters are passed through a pointer to a apiSetPermissionPasswordSpaceRootRequest struct via the builder pattern

Name	Type	Description	Notes

sharingLinkPassword | SharingLinkPassword | New password value |

Return type

Permission

Authorization

openId, basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdatePermissionSpaceRoot

Permission UpdatePermissionSpaceRoot(ctx, driveId, permId).Permission(permission).Execute()

Update sharing permission

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/owncloud/libre-graph-api-go"
)

func main() {
	driveId := "driveId_example" // string | key: id of drive
	permId := "permId_example" // string | key: id of permission
	permission := *openapiclient.NewPermission() // Permission | New property values

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DrivesRootApi.UpdatePermissionSpaceRoot(context.Background(), driveId, permId).Permission(permission).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DrivesRootApi.UpdatePermissionSpaceRoot``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdatePermissionSpaceRoot`: Permission
	fmt.Fprintf(os.Stdout, "Response from `DrivesRootApi.UpdatePermissionSpaceRoot`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
driveId	string	key: id of drive
permId	string	key: id of permission

Other Parameters

Other parameters are passed through a pointer to a apiUpdatePermissionSpaceRootRequest struct via the builder pattern

Name	Type	Description	Notes

permission | Permission | New property values |

Return type

Permission

Authorization

openId, basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

DrivesRootApi.md

Latest commit

History

DrivesRootApi.md

File metadata and controls

\DrivesRootApi

CreateDriveItem

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateLinkSpaceRoot

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeletePermissionSpaceRoot

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetPermissionSpaceRoot

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetRoot

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

InviteSpaceRoot

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListPermissionsSpaceRoot

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SetPermissionPasswordSpaceRoot

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdatePermissionSpaceRoot

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers