|
EForms Automatic Asynchrouns Tasks Management
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| delete | Delete a task. (administrative) |
| get | Return details of a task. (administrative) |
| list | Return list of tasks. (administrative) |
| submit | Return list of tasks. (administrative) |
| update | Update task. (administrative) |
| update_status | Update task status. (administrative) |
services/eforms/tasks/delete ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/tasks/delete | ||||||
|
Delete a task. | ||||||
| user_id | required | Id of aperson scheduling a task | ||||
| guid | required | GUID of the task to be deleted | ||||
| force_delete | optional | Force deletion of a task | ||||
| 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: A common SUCCESS status `message`. | ||||||
services/eforms/tasks/get ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/tasks/get | ||||||
|
Return details of a task. | ||||||
| user_id | required | Id of a person requesting the task | ||||
| guid | required | GUID of the task to be deleted | ||||
| long | optional |
Default value: false Should return long version of the task description with metadata and detailed log |
||||
| fields | optional |
Default value: message|task 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 common SUCCESS status `message` and and task object. | ||||||
services/eforms/tasks/list ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/tasks/list | ||||||
|
Return list of tasks. | ||||||
| eform_type_code | optional | List tasks for specific eform type | ||||
| org_unit_code | optional | List tasks for specific organizational unit | ||||
| module_code | optional | List tasks for specific organizational unit | ||||
| user_id | optional | List tasks submitted by a user | ||||
| notes | optional | List tasks containing a text in the notes field | ||||
| calendar_id | optional | List of tasks for eforms submitted for a specific calendar cycle | ||||
| from_date | optional | List of tasks submitted after | ||||
| to_date | optional | List of tasks submitted before | ||||
| start | optional | first record to return | ||||
| num | optional | maximum number of records to return | ||||
| 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 collection (`items`) of scheduled tasks. | ||||||
services/eforms/tasks/submit ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/tasks/submit | ||||||
|
Return list of tasks. | ||||||
| user_id | required | Id of aperson scheduling a task | ||||
| module_code | required | List tasks for specific organizational unit | ||||
| eform_guid | optional | GUID of the eform to schedule a task | ||||
| notes | optional | A text in the notes field | ||||
| start_after_date | optional | Specify a date and time after which the task should be executed | ||||
| 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 common SUCCESS status `message`. | ||||||
services/eforms/tasks/update ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/tasks/update | ||||||
|
Update task. | ||||||
| user_id | required | Id of a person requesting the task | ||||
| guid | required | GUID of the task to be deleted | ||||
| status | optional | New status of a task. NOWY, WTRAKCIE, BLAD, OK | ||||
| fields | optional |
Default value: message|task 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 common SUCCESS status `message`. | ||||||
services/eforms/tasks/update_status ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/tasks/update_status | ||||||
|
Update task status. | ||||||
| user_id | required | Id of aperson scheduling a task | ||||
| guid | required | GUID of the task to be updated | ||||
| status_code | required | New status code to be assigned | ||||
| notes | optional | A text in the notes field | ||||
| 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: A common SUCCESS status `message`. | ||||||