Student Forms - Processes administering methods
:: services/eforms/processes module

These API methods allow to manage processes flows available during the procedures.

Methods

delete Delete eform process. (administrative)
get_for_edit Return data for editing process meta data. (administrative)
get_step_for_edit Return data for editing process step data. (administrative)
list_for_edit Return eform processes for editing. (administrative)
list_steps_for_edit Return eform processes steps for editing. (administrative)
replace_status Replace all accurances of the old_status with new_status in all branches (both start and end nodes will be replaced). The statuses of the applications will also be replaced. (administrative)
step_delete Delete eform process step. (administrative)
step_update Create or update eform process step. (administrative)
update Create or update eform process. (administrative)

services/eforms/processes/delete

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/eforms/processes/delete

Delete eform process.

user_id required Required id of a person reponsible for deleting the eform process.
process_id required Required id of process to delete
fields optional

Default value: message

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

cascade_flow optional Should the flow be deleted too!
format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization.

Returned value:

Status message

services/eforms/processes/get_for_edit

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/eforms/processes/get_for_edit

Return data for editing process meta data.

user_id required

Required id of a person reponsible for requesting data to edit.

process_id optional Optional id of process to edit

process_code optional Optional code of process to edit

fields optional

Default value: item|message

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization.

Returned value:

An item to be edited (can be null).

services/eforms/processes/get_step_for_edit

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/eforms/processes/get_step_for_edit

Return data for editing process step data.

user_id required

Required id of a person reponsible for requesting data to edit.

start_status_id optional Optional id of start status

end_status_id optional Optional id of end status

start_status_code optional Optional code of start status

end_status_code optional Optional code of end status

process_id optional Optional id of process to edit (required either id or code)
process_code optional Optional code of process to edit (required either id or code)
fields optional

Default value: item|message

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization.

Returned value:

An item to be edited (can be null).

services/eforms/processes/list_for_edit

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/eforms/processes/list_for_edit

Return eform processes for editing.

user_id required Id of a user displaying list
code optional Code of the process
name_or_description optional Text existing in name or description of an eform proces (using ilike)
orgunit_code optional Organizational unit using this procedure (using ilike for matching)
eformtype_code optional Code of eform using this procedure (using ilike for matching)
active optional Can be None, True or False. When None then the filter is ignored, otherwise is applied.
category optional

Default value: STUD

Category of processes `STUD`, `DOKT` or `PRAC`
start optional first record to return
num optional maximum number of records to return
fields optional

Default value: items|total

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization.

Returned value:

A list of eform processes entries...

services/eforms/processes/list_steps_for_edit

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/eforms/processes/list_steps_for_edit

Return eform processes steps for editing.

user_id required Id of a user displaying list
process_id required Id of a user displaying list
fields optional

Default value: items

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization.

Returned value:

A list of eform processes steps entries...

services/eforms/processes/replace_status

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/eforms/processes/replace_status

Replace all accurances of the old_status with new_status in all branches (both start and end nodes will be replaced). The statuses of the applications will also be replaced.

user_id required Required id of a person reponsible for replacing status.
process_id required Required id of process to replace status
old_status_id required Required id of old status
new_status_id required Required id of new status
fields optional

Default value: message|no_applications|no_steps

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

check_only optional

Default value: true

If True the only steps and applications which would be updated are searched and the numbers of predicted modifications are returned
format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization.

Returned value:

Status message

services/eforms/processes/step_delete

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/eforms/processes/step_delete

Delete eform process step.

user_id required Required id of a person reponsible for deleting the eform process.
process_id required Required id of process to edit

start_status_id required Required id of start status

end_status_id required Required id of end status

fields optional

Default value: message

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization.

Returned value:

Status message

services/eforms/processes/step_update

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/eforms/processes/step_update

Update fields of a process step:

The parameter `process_id` is required.

The parameter `start_status_id` is required.

The parameter `end_status_id` is required.

user_id required

Required id of a person reponsible for updating process step.

process_id required Required id of process to edit

start_status_id required Required id of start status

end_status_id required Required id of end status

operation required create | update
data required

A JSON object containg atributes of a new item or the one to be updated. Only passed fields will be updated.

Expected structure example:

{
    "button_label_pl": ..., # ETYKIETA_PRZYCISKU
    "button_label_en": ..., # ETYKIETA_PRZYCISKU_ANG
    "name_en": ..., # NAZWA_ANG
    "confirmation_label_pl": ..., # POTWIERDZENIE_PRZYCISKU
    "confirmation_label_en": ..., # POTWIERDZENIE_PRZYCISKU_ANG
    "comment": ..., # KOMENTARZ
    "automatize_after_days": ..., # AUTOMAT_PO_CZASIE

    "notify_role_by_email": true/false, # CZY_EMAIL_ROLA
    "notify_role_email_pl": ..., # ROLA_EMAIL_SZABLON
    "notify_role_email_en": ..., # ROLA_EMAIL_SZABLON_ANG

    "notify_owner_by_email": true/false, # CZY_EMAIL_WLASCICIEL
    "notify_owner_email_pl": ..., # WLASC_EMAIL_SZABLON
    "notify_owner_email_en": ..., # WLASC_EMAIL_SZABLON_ANG

    "metadata": ..., # METADANE
    "responsible_role_code": ..., # ROLA_ODPOWIEDZIALNA

}
            
fields optional

Default value: message

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization.

Returned value:

Status message

services/eforms/processes/update

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/eforms/processes/update

Update fields of a process:

The parameter `process_id` is optional (if Null then a new item will be created).

user_id required

Required id of a person reponsible for updating process.

data required

A JSON object containg atributes of a new item or the one to be updated. Only passed fields will be updated.

Expected structure example:

{
    "code": ..., # KOD
    "name_pl": ..., # NAZWA
    "name_en": ..., # NAZWA_ANG
    "description_pl": ..., # OPIS
    "description_en": ..., # OPIS_ANG
    "instruction": ..., # INSTRUKCJA_WEWN
    "active": true/false, # CZY_AKTUALNY
    "category": 'STUD|DOKT|PRAC' # KATEGORIA
    "valid_eform_types_codes": '1000-DZPODWWW' # rozdzielone przecinkami kody typów podań, dla któych proce powinien wybieralny
}
            
fields optional

Default value: message

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

process_id optional Optional id of process to edit

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization.

Returned value:

Status message

USOS API ver. 7.1.0.0-7, 00772e87 (2024-11-13)