Filesystem APIs

Assimilate Groups For Path (POST)

Assimilate a existing group into the Group Wizard of ARM.

Route

URI	/api/v1/filesystem/AssimilateGroupsForPath
Method	POST
Result	JSON – ChangeResult

Parameters

Name	Type	Mandatory	Description
model	GroupwizardAssimilationModel	No	The settings for assimilation.

Response Structure Returns ChangeResult object containing:

• Success: bool value

• Data: object value

• ResponseId: Guid? value

• ErrorDetails: ExternalInterfaceException value

Example

POST http://localhost/api/v1/filesystem/AssimilateGroupsForPath

Example Response

{     "Success": true,     "Data": {},     "ResponseId": "123e4567-e89b-12d3-a456-426614174000",     "ErrorDetails": {} }

Change Directory (POST)

Change Directory.

Route

URI	/api/v1/filesystem/directory
Method	POST
Result	JSON – IActionResult

Parameters

Name	Type	Mandatory	Description
data	FileSystemDirectoryChangeArgument	No

Example

POST http://localhost/api/v1/filesystem/directory

Group Wizard Add Permissions (POST)

Add permissions for an resource.

Route

URI	/api/v1/filesystem/GroupWizardAddPermissions
Method	POST
Result	JSON – ChangeResult[]

Parameters

Name	Type	Mandatory	Description
permissionModel	GroupwizardPermissionModel	No	The permission settings.

Response Structure Returns ChangeResult[] object containing:

• Success: bool value

• Data: object value

• ResponseId: Guid? value

• ErrorDetails: ExternalInterfaceException value

Example

POST http://localhost/api/v1/filesystem/GroupWizardAddPermissions

Example Response

{     "Success": true,     "Data": {},     "ResponseId": "123e4567-e89b-12d3-a456-426614174000",     "ErrorDetails": {} }

Get Group Wizard Path Id (GET)

Calculates the pathId for a given resource key.

Route

URI	/api/v1/filesystem/groupwizardpathid
Method	GET
Result	JSON – IActionResult

Parameters

Name	Type	Mandatory	Description
key	string	No

Example

GET http://localhost/api/v1/filesystem/groupwizardpathid

Group Wizard Path Ids (GET)

Returns all the 8manIds for a given filesystem resource key.

Route

URI	/api/v1/filesystem/GroupWizardPathIds
Method	GET
Result	JSON – IActionResult

Parameters

Name	Type	Mandatory	Description
key	string	No	The filesystem resource address like path:///fs/\\ServerName\ShareForAll\Test
recrusiv	bool	No	Reserved, not in use. Is always interpreted as true.

Example

GET http://localhost/api/v1/filesystem/GroupWizardPathIds

Add Log Entries (POST)

Adds multiple entries to the 8man log.

Route

URI	/api/v1/filesystem/logentries
Method	POST
Result	JSON – ChangeResult[]

Parameters

Name	Type	Mandatory	Description
data	FilesystemLogEntryArgument[]	No

Response Structure Returns ChangeResult[] object containing:

• Success: bool value

• Data: object value

• ResponseId: Guid? value

• ErrorDetails: ExternalInterfaceException value

Example

POST http://localhost/api/v1/filesystem/logentries

Example Response

{     "Success": true,     "Data": {},     "ResponseId": "123e4567-e89b-12d3-a456-426614174000",     "ErrorDetails": {} }

Add Log Entry (POST)

Adds a entry to the 8man log.

Route

URI	/api/v1/filesystem/logentry
Method	POST
Result	JSON – ChangeResult

Parameters

Name	Type	Mandatory	Description
data	FilesystemLogEntryArgument	No

Response Structure Returns ChangeResult object containing:

• Success: bool value

• Data: object value

• ResponseId: Guid? value

• ErrorDetails: ExternalInterfaceException value

Example

POST http://localhost/api/v1/filesystem/logentry

Example Response

{     "Success": true,     "Data": {},     "ResponseId": "123e4567-e89b-12d3-a456-426614174000",     "ErrorDetails": {} }

Change Share Permissions (PUT)

Change permissions on file/share

Route

URI	/api/v1/filesystem/permissions
Method	PUT
Result	JSON – IActionResult

Parameters

Name	Type	Mandatory	Description
data	SetFilesystemPermissionsArgument	No

Example

PUT http://localhost/api/v1/filesystem/permissions

Set Share Permissions (POST)

Set permissions for the given filesystem element.

Route

URI	/api/v1/filesystem/permissions
Method	POST
Result	JSON – IActionResult

Parameters

Name	Type	Mandatory	Description
data	SetFilesystemPermissionsArgument	No

Example

POST http://localhost/api/v1/filesystem/permissions

Remove Share Permissions (DELETE)

removes a permission for a file/share

Route

URI	/api/v1/filesystem/permissions
Method	DELETE
Result	JSON – IActionResult

Parameters

Name	Type	Mandatory	Description
data	SetFilesystemPermissionsArgument	No

Example

DELETE http://localhost/api/v1/filesystem/permissions

Get File System Resource (GET)

reads permissions for file/share

Route

URI	/api/v1/filesystem/permissions
Method	GET
Result	JSON – IEnumerable<AclEntryModel>

Parameters

Name	Type	Mandatory	Description
key	string	No

Response Structure Returns IEnumerable<AclEntryModel> object containing:

• PropagationAndInheritance: string value

• PropagationFlags: int value

• InheritanceFlags: int value

Example

GET http://localhost/api/v1/filesystem/permissions

Example Response

{     "PropagationAndInheritance": "sample",     "PropagationFlags": 1,     "InheritanceFlags": 1 }

Get Tree From Path (GET)

Retrieves the tree for a given key element.

Route

URI	/api/v1/filesystem/tree
Method	GET
Result	JSON – IEnumerable<FilesystemEntryModel>

Parameters

Name	Type	Mandatory	Description
key	string	No
depth	int?	No

Response Structure Returns IEnumerable<FilesystemEntryModel> object containing:

• DisplayName: Displayname of the share

• Description: Description of a share or directory

• Path: Path of the directory or share

• UriKey: UriKey of the directory or share

• Acl: Access Control List Flags

• ServerName: Name of the server where the share is hosted on

• Type: Type of returned object: Share or Dir

• Childs: List of child objects.

• DataOwner: List<string> value

Example

GET http://localhost/api/v1/filesystem/tree

Example Response

{     "DisplayName": "sample",     "Description": "sample",     "Path": "sample",     "UriKey": "sample",     "Acl": 1,     "ServerName": "sample",     "Type": "sample",     "Childs": {},     "DataOwner": {} }