Function task_list_api

default/methods/task/task/task_list.py:44–78

(project_string_id)

@routes.route('/api/v1/project/<string:project_string_id>/task/list', methods = ['POST'])
@Project_permissions.user_has_project(["admin", "annotator", "Editor", "Viewer"])
def task_list_api(project_string_id):
    spec_list = [{'date_from': None},
                 {'date_to': None},
                 {'status': None},
                 {'page_number': None},
                 {'job_id': {'required': False, 'kind': int}},
                 {'all_my_jobs': {'required': False, 'kind': bool}},
                 {'issues_filter': None},
                 {'project_string_id': None},
                 {'project_id': {
                     'required': False,
                     'kind': int
                 }},
                 {'file_id': {
                     'required': False,
                     'kind': int
                 }},
                 {'incoming_directory_id': None},
                 {'limit_count': {'required': False, 'kind': int, 'default': 10}},
                 {'mode_data': str}]

    log, input, untrusted_input = regular_input.master(request = request,
                                                       spec_list = spec_list)
    with sessionMaker.session_scope() as session:
        if len(log["error"].keys()) >= 1:
            return jsonify(log = log), 400
        # For now we are not supporting querying the entire file list of a project.
        # So we check we have either a job ID or a FileID to filter with
        if input['file_id'] is None and input['job_id'] is None and input.get('all_my_jobs') is None:
            log['error']['file_id'] = 'Please Provide a file ID'
            log['error']['job_id'] = 'Please Provide a job ID'
            return jsonify(log = log), 400
        member = get_member(session)
        project = Project.get_by_string_id(session, project_string_id = project_string_id)
        return _task_list_api(session = session, project_id = project.id, input = input, log = log, member = member)


def _task_list_api(session, project_id, input = input, member = None, log = regular_log.default()):