Person is a data base user registration in SimDM data model. The registration specifies data base login and could define default access type/role of the user (administrator, manager, editor, reader) against the model. Data base user should be registered (has corresponding person instance) in target model to work with its content.
QUERY_FUNCTION person_list_types: LIST OF STRING
To call the query logged in user shall be associated with a person granted with administrative privileges over whole pbs (ADMIN_TYPE for the person or group where the person is registered)
QUERY_FUNCTION person_create(subject: v_person): v_person
subject |
input parameter of the person, see v_person some attributes of the input are ignored, like the following:
|
Returns actual attributes of the newly registered person (see v_person)
NOTE: temporary depricated functionality to avoid troubles with access rights
QUERY_FUNCTION person_create_by_login: v_person
Returns attributes of registered person (see v_person)
To call the query logged in user shall be associated with a person granted with reader privileges over whole pbs (READER_TYPE, EDITOR_TYPE, ADMIN_TYPE for the person or group where the person is registered)
QUERY_FUNCTION person_get(id: INTEGER): v_person
id | id of the person instance |
Returns actual data of the required person (see v_person)
To call the query logged in user shall be associated with a person granted with reader privileges over whole pbs (READER_TYPE, EDITOR_TYPE, ADMIN_TYPE for the person or group where the person is registered)
QUERY_FUNCTION person_list(ids: LIST OF INTEGER): LIST OF v_person
ids | list of interesting person instance id-s |
Returns list of actual data of the persons (see v_person)
To call the query logged in user shall be associated with a person granted with reader privileges over whole pbs (READER_TYPE, EDITOR_TYPE, ADMIN_TYPE for the person or group where the person is registered)
QUERY_FUNCTION person_get_by_login(id: STRING): v_person
id | data base login of the person |
Returns actual data of the required person (see v_person)
QUERY_FUNCTION person_get_me: v_person
Returns actual data of the logged in user (see v_person)
QUERY_FUNCTION person_select( pbs, organization : INTEGER; version : STRING; role : STRING): LIST OF v_personParameters:
pbs | (optional) instance id of parent pbs |
organization | (optional) instance id of hosting organisation|group |
version | (optional) version of parent PBS |
role | (optional) person's type/role |
Returns list of found persons (see v_person)
To call the query logged in user shall be associated with a person granted with administrative privileges over whole pbs (ADMIN_TYPE for the person or group where the person is registered)
QUERY_FUNCTION person_update(subject: v_person): v_person
subject |
updated data of the person definition to be updated in model (see v_person) Target instance specified by subject.item.instance_id The following attributes are ignored:
|
Returns actual data of the updated person definition (see v_person)
To call the query logged in user shall be associated with a person granted with administrative privileges over whole pbs (ADMIN_TYPE for the person or group where the person is registered)
QUERY_FUNCTION person_cancel(id: INTEGER): BOOLEAN
id | instance id of the person to be cancelled |
Returns TRUE if the instance deleted (was not used), FALSE if just cancelled