Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...


Note

Unlike other REST APIs, these use the file ID (found in the Browser) or the UUID (found in all payloads or json representations) instead of the configuration ID.

The REST API for files follows the best practices for RESTful API design. Ensure you read the HTTP status codes and interpret them together with the responses.

...

Returns a list of the file information in Datameer.

URI syntax

Code Blocknoformat
curl -u '<username>:<password>' -X GET 'http://<Datameer-serverIP>:<port-number>/api/filesystem/files/<file-id> or <uuid>'

...

Returns a list of the file permissions in Datameer.

URI syntax

Code Blocknoformat
curl -u '<username>:<password>' -X GET 'http://<Datameer-serverIP>:<port-number>/api/filesystem/files/<file-id> or <uuid>/permission'

Example response

Code Block
{
  "others": {
    "executable": true,
    "readable": true,
    "writable": true
  },
  "owner": "system",
  "_links": {
    "others": {
      "href": "/api/filesystem/files/26/permission/others"
    },
    "file": {
      "href": "/api/filesystem/files/26"
    },
    "owner": {
      "href": "/api/filesystem/files/26/permission/owner"
    },
    "self": {
      "href": "/api/filesystem/files/26/permission"
    },
    "groups": {
      "href": "/api/filesystem/files/26/permission/groups"
    }
  }

...

Returns a list of the file group permissions in Datameer.

URI syntax

Code Blocknoformat
curl -u '<username>:<password>' -X GET 'http://<Datameer-serverIP>:<port-number>/api/filesystem/files/<file-id> or <uuid>/permission/groups'

Example response

Code Block
 
{
  "_links": {
    "self": {
      "href": "/api/filesystem/files/26/permission/groups"
    },
    "permission": {
      "href": "/api/filesystem/files/26/permission"
    }
  },
  "_embedded": {
    "groups": [
      {
        "flags": {
          "executable": true,
          "readable": true,
          "writable": true
        },
        "name": "dasuser",
        "_links": {
          "self": {
            "href": "/api/filesystem/files/26/permission/groups/dasuser"
          },
          "permission": {
            "href": "/api/filesystem/files/26/permission"
          }
        }
      }
    ]
  }

...

Returns a list of the file permissions for others in Datameer.

URI syntax

Code Blocknoformat
curl -u '<username>:<password>' -X GET 'http://<Datameer-serverIP>:<port-number>/api/filesystem/files/<file-id> or <uuid>/permission/others'

...

Returns the owner of file in Datameer.

URI syntax

Code Blocknoformat
curl -u '<username>:<password>' -X GET 'http://<Datameer-serverIP>:<port-number>/api/filesystem/files/<file-id> or <uuid>/permission/owner'

...

Changes the owner of file in Datameer.

URI syntax

Code Blocknoformat
curl -u <username>:<password> -X PUT -H 'Content-Type:application/json' -H 'Accept: application/json'  -d "{owner:<username>}" 'http://
<Datameer-serverIP>:<port-number>/api/filesystem/files/<file-id> or <uuid>/permission/owner'

...

Sets permissions for groups created in Datameer. 

URI syntax

Code Blocknoformat
curl -u <username>:<password> -X POST -H 'Content-Type:application/json' -d '{name:<groupName>, flags:{fullResults:<true/false>, readable:<true/false>, writable:<true/false>, executable:<true/false> }}' 'http://<Datameer-serverIP>:<port-number>/api/filesystem/files/<file-id> or <uuid>/permission/groups'

...

Changes permissions for groups created in Datameer.

URI syntax

Code Blocknoformat
curl -u <username>:<password> -X PUT -H 'Content-Type:application/json' -d '{name:<groupName>, flags:{fullResults:<true/false>, readable:<true/false>, writable:<true/false>, executable:<true/false>}}' 'http://<Datameer-serverIP>:<port-number>/api/filesystem/files/<file-id> or <uuid>/permission/groups/<groupName>'

...

Changes permissions for others in Datameer.

URI syntax

Code Blocknoformat
curl -u <username>:<password> -X PUT -H 'Content-Type:application/json' -d ' {fullResults:<true/false>, readable:<true/false>, writable:<true/false>, executable:<true/false>}' 'http://<Datameer-serverIP:<port-number>/api/filesystem/files/<file-id> or <uuid>/permission/others'

...

Deletes the group permissions of a file in Datameer.

URI syntax

Code Blocknoformat
curl -u <username>:<password> -X DELETE 'http://<Datameer-serverIP>:<port-number>/api/filesystem/files/<file-id> or <uuid>/permission/groups/<group-name>'

...