Data types

This section will explain the different type data that can be obtained by the API.

Roles

Three built-in “roles” (permission/clearance) levels exists for accsyn users, the clearance dictates what data can be read and write through the API:

• Admins; Are allowed to read and write all data – configure accsyn.

• Employees; Are allowed full access to jobs and data on all shares.

• Users; (i.e. remote freelancers/customers) Besides receiving packages, they are only allowed to access share’s explicitly given access through ACLs (Access Control Lists). Restricted users automatically is given a share @ default location - <root share>/accsyn/<user id (email)>.

Entities

Data read from accsyn using the API arrives as JSON dictionaries, categorised by entity types:

accsyn entitytypes and role permissions

Entity type:	Description:	Admin:		Employee:		User (restricted):
		Read	Write	Read	Write	Read	Write
User	User profile data	YES	YES	YES	YES 1	YES 2	YES 2
Organization	Global domain settings	YES	YES	YES	NO	NO	NO
Job	A (transfer) job containing tasks	YES	YES	YES	YES	YES 3	YES 3
Task	A file/directory that should be transferred within a job.	YES	YES	YES	YES	YES 3	YES 3
Share	Defines a sub-directory beneath a root share that should be made available to users.	YES	YES	YES	YES 4	YES 5	YES 5
Root share	Defines a directory, typically on a network volume, that is to be made available to accsyn for file transfers and other operations.	YES	YES	NO	NO	NO	NO

• ¹ Their own and restricted users.

• ² Only their own.

• ³ If involved in job either as sending or receing part.

• ⁴ Except admin or other employee home shares.

• ⁵ Home share and share given explicit access through ACL.

To retrieve a list of all known entity types:

session.find("entitytypes")

This will return a list of entity types as string, i.e. [“user”,”organization”,”job”,..].

Attributes

Each entity has its own attributes, such as “id” or “code”(an accsyn abbreviation for an unique “name”).

To retrieve a list of known attributes for an entity:

session.find('attributes WHERE entitytype=job')

This will return a list of attributes entities of that entity type can have, i.e. [“id”,”code”,”status”,…].

Note

Depending role/clearance, some attributes might be not visible if accessing the API as an restricted user.

By default, all readable attributes are returned. To return attributes only allowed during creation and edit:

session.find('attributes WHERE entitytype=job', create=True)

session.find('attributes WHERE entitytype=job', update=True)