{"swagger":"2.0","host":false,"tags":[{"name":"BranchDashboardEnrollment","description":"Branch reports"},{"name":"Mytranscript","description":"All APIs related to my transcript"},{"name":"Pdf","description":"Pdf Controller"},{"name":"Policy","description":"Privacy Policy Reports"},{"name":"QueryBuilder","description":"Manage notifications"},{"name":"Report","description":"All APIs related to the reporting system"},{"name":"Terms","description":"Terms & Conditions Reports"},{"name":"Userreport","description":"Contains API endpoints that call legacy APIs"}],"info":{"title":"Report","version":"1.0","description":""},"paths":{"/report/v1/branch_dashboard_enrollment/{id}/view":{"get":{"tags":["BranchDashboardEnrollment"],"operationId":"BranchDashboardEnrollment./report/v1/branch_dashboard_enrollment/{id}/view","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"The ID of the branch"},{"in":"query","name":"hide_deactivated_users","type":"boolean","required":false,"description":"Exclude inactive users"}],"summary":"Detailed Information For The Children Of The Current Branch","last_modified_date":"","description":"Get detailed information for the children of the current branch. Shows details of user counts and course enrollment statuses.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportBranchdashboardenrollmentViewResponse"}},"400":{"description":"General Error","error_codes":{"1001":"The requested branch doesn't exist.","1008":"Invalid flag hide_deactivated_users \"%s\""}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/branch_dashboard_enrollment/{id}/view/export/{type}":{"get":{"tags":["BranchDashboardEnrollment"],"operationId":"BranchDashboardEnrollment./report/v1/branch_dashboard_enrollment/{id}/view/export/{type}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"The ID of the branch"},{"in":"path","enum":["xls","csv"],"name":"type","type":"string","required":true,"description":"The file type of the export, possible values are: XLS and CSV."},{"in":"query","enum":["title","has_children","total_users","enrolled","completed","in_progress","subscribed","overdue"],"name":"sort_attr","type":"string","required":false,"description":"Sort by attribute, possible values are: title, has_children, total_users, enrolled, completed, in_progress or subscribed,overdue. This paramater is optional."},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"The sorting direction, possible values are &quot;asc&quot; for ascending or &quot;desc&quot; for descending. This parameter is optional."},{"in":"query","name":"hide_deactivated_users","type":"boolean","required":false,"description":"If set to TRUE, this will exclude inactive users, if FALSE inactive users will be shown. This parameter is optional."}],"summary":"Exports The Detailed Information For Current Branch And Children","last_modified_date":"","description":"Exports detailed information for the current branch by ID, can be sorted by various attributes and filtered by active or inactive users. Is not feasible to test this API with api-browser. Use postman or similar tools.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportBranchdashboardenrollmentViewExportResponse"}},"400":{"description":"General Error","error_codes":{"1001":"The requested branch doesn't exist.","1004":"Invalid sorting attribute \"%s\"","1005":"Invalid sorting direction \"%s\"","1006":"Invalid export type \"%s\"","1008":"Invalid flag hide_deactivated_users \"%s\""}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/branch_dashboard_enrollment/{id}/view/export/pdf":{"post":{"tags":["BranchDashboardEnrollment"],"operationId":"BranchDashboardEnrollment./report/v1/branch_dashboard_enrollment/{id}/view/export/pdf","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ReportBranchdashboardenrollmentViewExportPdfSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"The ID of the branch. This is required."}],"summary":"Exports The Detailed Information For Current Branch And Children","last_modified_date":"","description":"This endpoint exports the detailed information for the current branch based on its ID and its respective children in PDF format. Is not feasible to test this API with api-browser. Use postman or similar tools.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportBranchdashboardenrollmentViewExportPdfResponse"}},"400":{"description":"General Error","error_codes":{"1001":"The requested branch doesn't exist.","1007":"Invalid images","1008":"Invalid flag hide_deactivated_users \"%s\""}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/branch_dashboard_enrollment/{id}":{"get":{"tags":["BranchDashboardEnrollment"],"operationId":"BranchDashboardEnrollment./report/v1/branch_dashboard_enrollment/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"The ID of the branch"},{"in":"query","enum":["subscribed","in_progress","completed"],"name":"status","type":"string","required":false,"description":"Filter enrollments by status. Allowed values are &quot;subscribed&quot;, &quot;in_progress&quot; and &quot;completed&quot;. This parameter is optional."},{"in":"query","enum":["username","fullname","course_name","course_code","course_type","enrollment_date","completion_date","status","score","session_time","credits"],"name":"sort_attr","type":"string","required":false,"description":"The sorting parameter. Allowed values are &quot;username&quot;, &quot;fullname&quot;, &quot;course_name&quot;, &quot;course_code&quot;, &quot;course_type&quot;, &quot;enrollment_date&quot;, &quot;completion_date&quot; and &quot;status&quot;. This parameter is optional."},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"The sorting direction. Allowed values are &quot;asc&quot; for ascending&quot; or &quot;desc&quot; for descending. This parameter is optional."},{"in":"query","name":"page_size","type":"integer","required":false,"description":"The maximum number of results per page. The default value is equal to the value set in the Advanced Settings page. This parameter is optional."},{"in":"query","name":"hide_deactivated_users","type":"boolean","required":false,"description":"Exclude inactive users. The default value is &quot;false&quot;. This parameter is optional."}],"summary":"List Of Enrollments For Current Branch And Children","last_modified_date":"","description":"This endpoint retrieves a list of enrollment for the current branch and all its children.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportBranchdashboardenrollmentListResponse"}},"400":{"description":"General Error","error_codes":{"1001":"The requested branch doesn't exist.","1002":"Invalid status \"%s\"","1004":"Invalid sorting attribute \"%s\"","1005":"Invalid sorting direction \"%s\"","1008":"Invalid flag hide_deactivated_users \"%s\""}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/branch_dashboard_enrollment/{id}/export/{type}":{"get":{"tags":["BranchDashboardEnrollment"],"operationId":"BranchDashboardEnrollment./report/v1/branch_dashboard_enrollment/{id}/export/{type}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"The ID of the branch. This is required."},{"in":"path","enum":["xls"],"name":"type","type":"string","required":true,"description":"The type of the export. The allowed value is &quot;xls&quot;. This is required."},{"in":"query","enum":["subscribed","in_progress","completed"],"name":"status","type":"string","required":false,"description":"Filter enrollments by status. Possible values are &quot;subscribed&quot;, &quot;in_progress&quot; or &quot;completed&quot;. This parameter is optional."},{"in":"query","enum":["username","fullname","course_name","course_code","course_type","enrollment_date","completion_date","status","score","session_time","credits"],"name":"sort_attr","type":"string","required":false,"description":"The sorting field, possible values are &quot;username&quot;, &quot;fullname&quot;, &quot;course_name&quot;, &quot;course_code&quot;, &quot;course_type&quot;, &quot;enrollment_date&quot;, &quot;completion_date&quot;, &quot;status&quot;, &quot;score&quot;, &quot;session_time&quot; or &quot;credits&quot;. This parameter is optional."},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction, allowed values are &quot;asc&quot; for ascending and &quot;desc&quot; for descending. This parameter is optional."},{"in":"query","name":"hide_deactivated_users","type":"boolean","required":false,"description":"Exclude inactive users. The default value is &quot;false&quot;. This parameter is optional."}],"summary":"List Of Enrollments For Current Branch And Children","last_modified_date":"","description":"This endpoint retrieves a list of enrollments for the current branch and associated children. Is not feasible to test this API with api-browser. Use postman or similar tools.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportBranchdashboardenrollmentExportListResponse"}},"400":{"description":"General Error","error_codes":{"1001":"The requested branch doesn't exist.","1002":"Invalid status \"%s\"","1004":"Invalid sorting attribute \"%s\"","1005":"Invalid sorting direction \"%s\"","1006":"Invalid export type \"%s\"","1008":"Invalid flag hide_deactivated_users \"%s\""}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/branch_dashboard_enrollment/{id}/summary":{"get":{"tags":["BranchDashboardEnrollment"],"operationId":"BranchDashboardEnrollment./report/v1/branch_dashboard_enrollment/{id}/summary","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"The ID of the branch"},{"in":"query","name":"hide_deactivated_users","type":"boolean","required":false,"description":"If set to &quot;TRUE&quot;, inactive users will be excluded from the results."}],"summary":"Summary Of The Current Branch","last_modified_date":"","description":"This endpoint retrieves a summary of current branch showing total users, number of enrollments (and their statuses) and general information about the branch.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportBranchdashboardenrollmentSummaryResponse"}},"400":{"description":"General Error","error_codes":{"1001":"The requested branch doesn't exist.","1008":"Invalid flag hide_deactivated_users \"%s\""}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/mytranscript":{"get":{"tags":["Mytranscript"],"operationId":"Mytranscript./report/v1/mytranscript","parameters":[{"in":"query","name":"cursor","type":"string","description":"Data set navigational cursor previously obtained by passing get_cursor=1. This parameter is to be considered as deprecated and it will be removed in a future release.","default":""},{"in":"query","name":"get_cursor","type":"integer","description":"Generate and return \"cursor\" and prebuilt navigational \"_links\". Default=0. This parameter is to be considered as deprecated and it will be removed in a future release.","default":""},{"in":"query","name":"page_size","type":"integer","description":"Maximum number of results per page. Maximum value 200","default":"20"},{"in":"query","name":"page","type":"integer","description":"Page to return, default 1.","default":"1"},{"in":"query","enum":["name"],"name":"sort_attr","type":"string","required":false,"description":"Specify the column to sort the result by. Possible values are: &quot;name&quot;. The default value is name"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Specify the sorting direction. Possible values are &quot;asc&quot; for ascending or &quot;desc&quot; for descending. The default value is &quot;desc&quot;."},{"in":"query","name":"search_text","type":"string","required":false,"description":"Specify a search string to filter result by name."},{"in":"query","enum":["elearning","classroom","learningplan"],"name":"type","type":"string","required":false,"description":"An array to filter the result by course type and/or learning plan. Possible values are: &quot;elearning&quot;, &quot;classroom&quot; or &quot;learningplan&quot;."},{"in":"query","enum":["subscribed","in_progress","completed"],"name":"enrollment_status","type":"string","required":false,"description":"An array to filter the result by status. Possible values are &quot;subscribed&quot; for not yet started, &quot;in_progress&quot; for in progress or &quot;completed&quot; for completed."},{"in":"query","name":"only_with_credits","type":"boolean","required":false,"description":"Set a string to TRUE if the result should contain courses awarding credits only, otherwise set to FALSE."},{"in":"query","name":"completion_date_from","type":"datetime","required":false,"description":"Filter the result by after the completion date using the format: yyyy-MM-dd HH:mm:ss."},{"in":"query","name":"completion_date_to","type":"datetime","required":false,"description":"Filter the result by up to the completion date using the format: yyyy-MM-dd HH:mm:ss. If the optional parameter [completion_date_from] is provided then [completion_date_to] can not be set to a date before [completion_date_from]."},{"in":"query","name":"enrollment_date_from","type":"datetime","required":false,"description":"Filter by after enrollment date using the format yyyy-MM-dd HH:mm:ss."},{"in":"query","name":"enrollment_date_to","type":"datetime","required":false,"description":"Filter the result by up to the enrollment date using the format yyyy-MM-dd HH:mm:ss. If the optional parameter [enrollment_date_from] is provided then [enrollment_date_to] can not be set to a date before [enrollment_date_from]."}],"summary":"Retrieve Transcripts List","last_modified_date":"","description":"This API call retrieves the transcripts list, optionally filtered. All additional parameters are optional.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportMytranscriptMyTranscriptListResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: sort_attr","1002":"Invalid parameter: sort_dir","1003":"Invalid parameter: {X}","1004":"completion_date_to must be after completion_date_from","1005":"enrollment_date_to must be after enrollment_date_from"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/privacy_policy/users":{"get":{"tags":["Policy"],"operationId":"Policy./report/v1/privacy_policy/users","parameters":[{"in":"query","name":"current_version_only","type":"boolean","required":false,"description":"Returns the latest accepted version per user if set to TRUE. Otherwise, if set to FALSE, it returns privacy policy acceptance history. The default value is FALSE. This parameter is optional."},{"in":"query","name":"hide_deactivated_user","type":"boolean","required":false,"description":"Returns only active users if set to TRUE. Otherwise returns both active and inactive users. The default value is FALSE. This parameter is optional."},{"in":"query","name":"all_fields","type":"boolean","required":false,"description":"Returns all available fields if set to TRUE. The default value is FALSE. This parameter is optional."},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"multidomain_ids","type":"array","required":false,"description":"An array of multi-domain client IDs. This parameter is optional. PLEASE NOTE: This filter can only be applied if the Extended Enterprise app is activated."},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"user_ids","type":"array","required":false,"description":"Filter data by an array of User IDs. This parameter is optional."},{"in":"query","enum":["csv"],"name":"export","type":"string","required":false,"description":"Export data to file. Possible values are &quot;csv&quot;. This parameter is optional."},{"in":"query","name":"branch_id","type":"integer","required":false,"description":"If a branch ID is supplied here, the results will be filtered by that ID. This parameter is optional."},{"in":"query","name":"selection_status","type":"integer","required":false,"description":"If this parameter is set to &quot;1&quot; then the results will display branches without children. If it is set to &quot;2&quot; then the results will display branches with children. The default value is &quot;1&quot;. This parameter is optional."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Select the fields to sort by. Possible values are: user_id, username, lastname, firstname, email, last_login, date_track, policy_id, policy_name, policy_accepted, version_id, version or domain. The default value is: user_id (descending), policy_id (ascending), version_id (ascending). This parameter is optional."},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Specify the sorting direction. Possible values are: &quot;asc&quot; for ascending or &quot;desc&quot; for descending. The default value is &quot;desc&quot;. This parameter is optional."},{"in":"query","name":"page","type":"integer","required":false,"description":"The page number to return. The default value is &quot;1&quot;. This parameter is optional."},{"in":"query","name":"page_size","type":"integer","required":false,"description":"The maximum number of results per page. The default value is &quot;10&quot;. This parameter is optional."},{"in":"query","name":"filters","type":"string","required":false,"description":"A serialized object containing list of filters and their options. List of filters is: ( policy_name:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains}, version:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains}, username:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains}, policy_accepted:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains} ). This parameter is optional."},{"in":"query","name":"search_text","type":"string","required":false,"description":"The text to search for in the data. This parameter is optional."},{"in":"query","name":"query_id","type":"string","required":false,"description":"The ID of the query"},{"in":"query","name":"next_token","type":"string","required":false,"description":"The token to recover the next chunk of data"}],"summary":"Report Data For Privacy Policy","last_modified_date":"","description":"This endpoint retrieves the report data for the privacy policy based on several parameters.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportPolicyUsersResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/privacy_policy/pdf":{"post":{"tags":["Policy"],"operationId":"Policy./report/v1/privacy_policy/pdf","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ReportPolicyPdfSchema"}}],"summary":"Generate PDF File That Include Charts For Privacy Policy","last_modified_date":"","description":"This endpoint generates a PDF file that includes charts, supplied by URL, for the privacy policy. Is not feasible to test this API with api-browser. Use postman or similar tools.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportPolicyPdfResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/privacy_policy/users/{id}":{"get":{"tags":["Policy"],"operationId":"Policy./report/v1/privacy_policy/users/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"The ID of the User"},{"in":"query","name":"current_version_only","type":"boolean","required":false,"description":"If the parameter is set to TRUE the latest accepted version per user is returned. Otherwise if the parameter is set to FALSE, the privacy policy acceptance history is returned. The default value is FALSE. This parameter is optional."},{"in":"query","name":"hide_deactivated_user","type":"boolean","required":false,"description":"If this parameter is set to TRUE then only users with the status of &quot;active&quot; are returned. The default value is FALSE. This parameter is optional."},{"in":"query","name":"all_fields","type":"boolean","required":false,"description":"If this parameter is set to TRUE then all available fields are returned. The default value is FALSE. This parameter is optional."},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"multidomain_ids","type":"array","required":false,"description":"An array of multi-domain client IDs. PLEASE NOTE: This filter can be applied only if the Extended Enterprise app is activated."},{"in":"query","enum":["csv"],"name":"export","type":"string","required":false,"description":"Exports the data to a file. Possible value is: &quot;csv&quot;. This parameter is optional."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"The sorting field. Possible values are: user_id, username, lastname, firstname, email, last_login, date_track, policy_id, policy_name, policy_accepted, version_id, version, domain. The default value is user_id. Please note, policy_id and version_id sort ascending by default, user_id sorts descending by default. This parameter is optional."},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Change the sorting direction. Possible values are: &quot;asc&quot; for ascending and &quot;desc&quot; for descending. The default value is &quot;desc&quot;. This parameter is optional."},{"in":"query","name":"page","type":"integer","required":false,"description":"The page number to return. The default value is &quot;1&quot;. This parameter is optional."},{"in":"query","name":"page_size","type":"integer","required":false,"description":"The maximum number of results displayed per page. The default value is &quot;10&quot;. This parameter is optional."},{"in":"query","name":"query_id","type":"string","required":false,"description":"The ID of the query"},{"in":"query","name":"next_token","type":"string","required":false,"description":"The token to recover the next chunk of data"}],"summary":"Report data for Privacy Policy for given user","last_modified_date":"","description":"The report data for the privacy policy for the given user, specified by ID.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportPolicyReportByUserResponse"}},"400":{"description":"General Error","error_codes":{"404":"User not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/privacy_policy/users/{id}/version/{version_id}":{"get":{"tags":["Policy"],"operationId":"Policy./report/v1/privacy_policy/users/{id}/version/{version_id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"The ID of the User"},{"in":"path","name":"version_id","type":"integer","required":true,"description":"The version ID"},{"in":"query","name":"id_track","type":"integer","required":false,"description":"The track ID"}],"summary":"Privacy Policy tracking for a given user","last_modified_date":"","description":"Tracks the privacy policy for a specific user by User ID and privacy policy version ID.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportPolicyUserTrackingResponse"}},"400":{"description":"General Error","error_codes":{"404":"User ID does not exist"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/query_builder":{"get":{"tags":["QueryBuilder"],"operationId":"QueryBuilder./report/v1/query_builder","parameters":[{"in":"query","name":"search_text","type":"string","required":false,"description":"A search string, providing a filtering by title function"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"The sorting field. Possible values are: &quot;id&quot;, &quot;title&quot;, &quot;last_edit_by&quot; or &quot;last_edit&quot;. The default value is &quot;id&quot;."},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"The sorting direction. Allowed values are: &quot;asc&quot; for ascending and &quot;desc&quot; for descending. The default value is &quot;desc&quot;."},{"in":"query","name":"page","type":"integer","required":false,"description":"The page number to return. The default value is &quot;1&quot;."},{"in":"query","name":"page_size","type":"integer","required":false,"description":"The maximum number of results per page. The default value is &quot;200&quot;."},{"in":"query","name":"get_total_count","type":"integer","required":false,"description":"If this value is set to &quot;1&quot; then the count of found items will be returned. Possible values are: &quot;0&quot; or &quot;1&quot;. The default value is &quot;0&quot;."},{"in":"query","name":"filters","type":"string","required":false,"description":"A serialized object containing a list of filters and their options. List of possible filters is: ( event:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains}, subject:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains}, body:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains}, sender_name:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains} )"}],"summary":"List Of Custom Query Builder Reports","last_modified_date":"","description":"This endpoint returns a list of custom 'Query Builder' reports, optionally filtered by title.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportQuerybuilderIndexResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"post":{"tags":["QueryBuilder"],"operationId":"QueryBuilder./report/v1/query_builder","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ReportQuerybuilderCreateSchema"}}],"summary":"Create Report Using 'Query Builder'","last_modified_date":"","description":"This endpoint creates a report using the Query Builder tool, using a supplied report name, SQL query and SQL parameters.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportQuerybuilderCreateResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Please provide a name","2000":"Please provide the sql_params_values parameter","2001":"Missing SQL parameter(s) - <params>","2002":"Invalid SQL type(s) - <types>","2003":"Missing name for parameter(s) - <params>","2004":"Invalid SQL parameter(s) - <params>","2005":"type can not be empty for <field>","3000":"Please provide sql_fields","3001":"Missing SQL field(s) - <fields>","3002":"Missing name for field(s) <fields>","3003":"Invalid SQL field(s) - <fields>","5000":"Please provide sql parameter","5001":"Invalid SQL","5002":"The SELECT statement can NOT contains '*'","7000":"Please provide '{0}'","7001":"The value of parameter <param> doesn't match the declared type <type>","7002":"Please provide sql_params_values","8100":"The provided type <type> of <param> doesn't match the provided value <value>","9000":"DB error"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["QueryBuilder"],"operationId":"QueryBuilder./report/v1/query_builder","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ReportQuerybuilderDeleteMultipleSchema"}}],"summary":"Delete Multiple Report Of Type 'Query Builder'","last_modified_date":"","description":"This endpoint deletes multiple reports of the type 'Query Builder' based on an array of report IDs","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportQuerybuilderDeleteMultipleResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Please provide IDs","1001":"Please provide valid data","1002":"DB problem","1003":"Unsuccessful deletion"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/query_builder/analyze":{"post":{"tags":["QueryBuilder"],"operationId":"QueryBuilder./report/v1/query_builder/analyze","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ReportQuerybuilderAnalyzeSchema"}}],"summary":"Analyze SQL, Receive SELECT Fields And Binded Parameters","last_modified_date":"","description":"Analyze if SQL is correct, get fields in SELECT statement, get binded parameters (parameters starting with ':')","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportQuerybuilderAnalyzeResponse"}},"400":{"description":"General Error","error_codes":{"5000":"Please provide SQL","5001":"Invalid SQL","5002":"SELECT statement can NOT contain a '*' character","7000":"Please provide <sql param>","7001":"The value of parameter <sql param> doesn't match the declarated type <param type>","7002":"Please provide 'sql_params_values'","7003":"DB error"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/query_builder/{id}":{"get":{"tags":["QueryBuilder"],"operationId":"QueryBuilder./report/v1/query_builder/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"The ID of the query builder"}],"summary":"Get The Details Of A Custom 'Query Builder' Report","last_modified_date":"","description":"Provides details such as title, creation date, user name of the author and JSON-encoded parameters of a custom 'Query Builder' report","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportQuerybuilderViewResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid Query builder ID"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["QueryBuilder"],"operationId":"QueryBuilder./report/v1/query_builder/{id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ReportQuerybuilderUpdateSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"Report ID"}],"summary":"Update 'Query Builder' Report","last_modified_date":"","description":"This endpoint allows updates to the name, SQL and SQL parameters of a 'Query Builder' report","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportQuerybuilderUpdateResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid Query builder ID","2000":"Please provide sql_params_values","2001":"Missing SQL parameter(s) - <params>","2002":"Invalid SQL type(s) - <types>","2003":"Missing name for parameter(s) - <params>","2004":"Invalid SQL parameter(s) - <params>","2005":"type can not be empty for <field>","3000":"Please provide sql_fields","3001":"Missing SQL field(s) - <fields>","3002":"Missing name for field(s) <fields>","3003":"Invalid SQL field(s) - <fields>","5001":"Invalid SQL","5002":"SELECT statement can NOT contain '*'","8100":"The provided type <type> of <param> doesn't match the provided value <value>","9000":"Model validation errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["QueryBuilder"],"operationId":"QueryBuilder./report/v1/query_builder/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"The report ID"}],"summary":"Delete Report From Type 'Query Builder'","last_modified_date":"","description":"This endpoint deletes a report of the type 'Query Builder' based on the report ID","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportQuerybuilderDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Please provide valid data","1002":"DB problem","1003":"Unsuccessful deletion"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/query_builder/execute_sql":{"post":{"tags":["QueryBuilder"],"operationId":"QueryBuilder./report/v1/query_builder/execute_sql","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ReportQuerybuilderExecuteSqlSchema"}}],"summary":"Validate And Execute SQL To Test It For DB Exceptions","last_modified_date":"","description":"This endpoint allows you to validate and execute SQL queries to test them for database exceptions and issues","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportQuerybuilderExecuteSqlResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Please provide SQL","1001":"Invalid SQL","1002":"The SELECT statement can NOT contain '*'","1003":"Please provide sql_params_values","1004":"<binded parameter> is declarated as <provided type> but provided value <provided value> does not match the type specified","1005":"Please provide <missing parameters>","1006":"Invalid params <invalid parameters>","1007":"DB exception"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/report":{"get":{"tags":["Report"],"operationId":"Report./report/v1/report","parameters":[{"in":"query","name":"only_public","type":"boolean","required":false,"description":"If set to TRUE, only public reports will be returned. Otherwise, if set to FALSE, all reports are returned."}],"summary":"Lists all reports created in the system","last_modified_date":"","description":"Provides a list, which can be filtered to show only public reports, of all reports created in the system.<br>Only available for SuperAdmin.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportReportReportsListResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/report/{report_id}/count":{"get":{"tags":["Report"],"operationId":"Report./report/v1/report/{report_id}/count","parameters":[{"in":"path","name":"report_id","type":"integer","required":true,"description":"The internal custom report ID, as returned by /report/v1/report."},{"in":"query","name":"date_from","type":"datetime","required":false,"description":"The start date and time used to additionally filter report rows (in yyyy-MM-dd HH:mm:ss format, UTC timezone). Used by the Audit Trail report."},{"in":"query","name":"date_to","type":"datetime","required":false,"description":"The end date &amp; time used to additionally filter report rows (in yyyy-MM-dd HH:mm:ss format, UTC timezone). Used by the Audit Trail report."}],"summary":"Returns The Number Of Records Matching The Specified Filters","last_modified_date":"","description":"This endpoint is usually needed for paginating report/extractRows. The number of rows depends on the custom report configuration and it should be properly set up inside the Docebo Learn Reports Management area.<br>Only available for SuperAdmin.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportReportReportCountRowsResponse"}},"400":{"description":"General Error","error_codes":{"201":"Missing or invalid parameter \"id_report\"","202":"The \"date_from\" - \"date_to\" time interval cannot be larger than one month"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/report/{report_id}/data":{"get":{"tags":["Report"],"operationId":"Report./report/v1/report/{report_id}/data","parameters":[{"in":"path","name":"report_id","type":"integer","required":true,"description":"The internal custom report ID, as returned by /report/v1/report."},{"in":"query","name":"date_from","type":"datetime","required":false,"description":"The start timestamp used to additionally filter report rows (in yyyy-MM-dd HH:mm:ss format, UTC timezone). Used by the Audit Trail report."},{"in":"query","name":"date_to","type":"datetime","required":false,"description":"The end timestamp used to additionally filter report rows (in yyyy-MM-dd HH:mm:ss format, UTC timezone). Used by the Audit Trail report."},{"in":"query","name":"from","type":"integer","required":false,"description":"The offset to use relative to the number of extracted rows (starts at 0). If this parameter is left empty the default value will be 0."},{"in":"query","name":"count","type":"integer","required":false,"description":"The number of records to return per call. If this parameter is left empty, the default value will be 500 which is also the maximum value."}],"summary":"Array Of Rows Extracted From A Custom Report, Matching A Specified Filter","last_modified_date":"","description":"Use /report/v1/report/[report_id]/count to calculate the number of needed pages. The format of each row depends on the custom report configuration and it should be properly set up inside the Docebo Learn Reports Management area.<br>Only available for SuperAdmin.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportReportReportFetchRowsResponse"}},"400":{"description":"General Error","error_codes":{"201":"Parameter \"count\" cannot be larger than 500","202":"Missing required parameter \"id_report\"","203":"The \"date_from\" - \"date_to\" time interval cannot be larger than one month"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/terms_and_conditions/users":{"get":{"tags":["Terms"],"operationId":"Terms./report/v1/terms_and_conditions/users","parameters":[{"in":"query","name":"current_version_only","type":"boolean","required":false,"description":"If this parameter is set to TRUE the latest accepted version per user is returned, otherwise the terms and conditions acceptance history is returned. The default value is FALSE."},{"in":"query","name":"hide_deactivated_user","type":"boolean","required":false,"description":"If this parameter is set to TRUE, the API returns only &#039;active&#039; users. The default value is FALSE."},{"in":"query","name":"all_fields","type":"boolean","required":false,"description":"If this parameter is set to TRUE, the API returns all available fields. The default is FALSE."},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"multidomain_ids","type":"array","required":false,"description":"An array of multidomain client IDs. This filter can be applied only if the Extended Enterprise app is activated."},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"user_ids","type":"array","required":false,"description":"Filter data by an array of User IDs"},{"in":"query","enum":["csv"],"name":"export","type":"string","required":false,"description":"Export data to file"},{"in":"query","name":"branch_id","type":"integer","required":false,"description":"Filter by branch ID"},{"in":"query","name":"selection_status","type":"integer","required":false,"description":"If this parameter is set to &quot;1&quot; then the API returns branches without children. If it is set to &quot;2&quot; then children are returned. The default value is &quot;1&quot;."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"The sort by field. The default value is to sort by user_id (DESC) then tc_id (ASC) then version_id (ASC). Possible values are: user_id, username, lastname, firstname, email, last_login, date_track, tc_id, tc_name, tc_accepted, version_id, version or domain."},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"The sorting direction. Possible values are &quot;asc&quot; for ascending and &quot;desc&quot; for descending. The default value is &quot;desc&quot;."},{"in":"query","name":"page","type":"integer","required":false,"description":"The page number to return. The default value is &quot;1&quot;."},{"in":"query","name":"page_size","type":"integer","required":false,"description":"The maximum number of results per page. The default value is &quot;10&quot;."},{"in":"query","name":"filters","type":"string","required":false,"description":"A serialized object containing a list of filters and their options. The list of filters is ( tc_name:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains}, version:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains}, username:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains}, tc_accepted:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains} )"},{"in":"query","name":"search_text","type":"string","required":false,"description":"The text to search in the data"}],"summary":"Report Data For The Terms & Conditions","last_modified_date":"","description":"This endpoint returns the report data for users, optionally filtered","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportTermsUsersResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/terms_and_conditions/pdf":{"post":{"tags":["Terms"],"operationId":"Terms./report/v1/terms_and_conditions/pdf","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ReportTermsPdfSchema"}}],"summary":"Generate PDF File That Includes Charts For The Terms & Conditions","last_modified_date":"","description":"This endpoint generates a PDF file that includes charts for the Terms and Conditions","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportTermsPdfResponse"}},"400":{"description":"General Error","error_codes":{"1007":"Invalid images","1008":"Wrong value for parameter \"chart_1\"","1009":"Wrong value for parameter \"chart_2\""}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/terms_and_conditions/users/{id}":{"get":{"tags":["Terms"],"operationId":"Terms./report/v1/terms_and_conditions/users/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"The ID of the User"},{"in":"query","name":"current_version_only","type":"boolean","required":false,"description":"If this paramater is set to TRUE the latest accepted version per user is returned, otherwise the terms and conditions acceptance history is returned. The default value is FALSE"},{"in":"query","name":"hide_deactivated_user","type":"boolean","required":false,"description":"If this paramater is set to TRUE the API returns only &#039;active&#039; users. The default value is FALSE."},{"in":"query","name":"all_fields","type":"boolean","required":false,"description":"If this parameter is set to TRUE then the API returns all available fields. The default is FALSE."},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"multidomain_ids","type":"array","required":false,"description":"An array of multidomain client IDs. This filter can be applied only if the Extended Enterprise App is activated."},{"in":"query","enum":["csv"],"name":"export","type":"string","required":false,"description":"Export data to file."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"The sort by field. The default value is user_id (DESC), tc_id (ASC), version_id (ASC). Possible options are user_id, username, lastname, firstname, email, last_login, date_track,tc_id, tc_name, tc_accepted, version_id, version or domain"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"The sorting direction. Possible values are &quot;asc&quot; for ascending or &quot;desc&quot; for descending. The default value is &quot;desc&quot;."},{"in":"query","name":"page","type":"integer","required":false,"description":"The page number to return. The default value is &quot;1&quot;."},{"in":"query","name":"page_size","type":"integer","required":false,"description":"The maximum number of results per page. The default value is &quot;10&quot;."}],"summary":"Report Data For The Terms & Conditions For Given User","last_modified_date":"","description":"This endpoint returns the report data for the Terms & Conditions for a specified user","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportTermsReportByUserResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/terms_and_conditions/users/{id}/version/{version_id}":{"get":{"tags":["Terms"],"operationId":"Terms./report/v1/terms_and_conditions/users/{id}/version/{version_id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"The ID of the User"},{"in":"path","name":"version_id","type":"integer","required":true,"description":"The version ID"},{"in":"query","name":"id_track","type":"integer","required":false,"description":"Track ID"}],"summary":"Terms & Conditions Tracking For A Given User","last_modified_date":"","description":"This endpoint tracks the Terms and Conditions based on supplied user ID and version ID.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportTermsUserTrackingResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/userreport":{"post":{"tags":["Userreport"],"operationId":"Userreport./report/v1/userreport","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ReportUserreportStartUsersReportSchema"}}],"summary":"Start A Background Report Creation Process And Return A JOB ID","last_modified_date":"","description":"This endpoint starts a background report creation process and returns a unique job ID to track its progress.<br>Only available for SuperAdmin.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportUserreportStartUsersReportResponse"}},"400":{"description":"General Error","error_codes":{"401":"Invalid \"user_ids\" parameter","402":"No user IDs provided","403":"Unable to schedule job"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/report/v1/userreport/{job_id}":{"get":{"tags":["Userreport"],"operationId":"Userreport./report/v1/userreport/{job_id}","parameters":[{"in":"path","name":"job_id","type":"string","required":true,"description":"The report ID, received from the POST call to /report/v1/userreport"}],"summary":"Check The Status Of A Background Report Job And Return The Data If Ready","last_modified_date":"","description":"This endpoint checks the status of a background report job and returns the data if it's ready.<br>Only available for SuperAdmin.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ReportUserreportUsersReportStatusResponse"}},"400":{"description":"General Error","error_codes":{"401":"No Job ID provided","402":"Job not found","403":"Invalid job state"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}}},"securityDefinitions":{"docebo_oauth":{"type":"oauth2","flow":"implicit","tokenUrl":"/oauth2/token","authorizationUrl":"/oauth2/authorize","scopes":{"api":"Common scope, used by the whole API"}}},"security":[{"docebo_oauth":["api"]}],"definitions":{"localizable":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the localizable object. This controls whether or not the value or values property below will be populated.","collectionFormat":"brackets","enum":["single_value","multi_lang"]},"value":{"type":"string","description":"The scalar value of this localizable object, used for all languages. Only populated when \"type=single_value\"."},"values":{"type":"object","description":"A lang_code=>value structured object with the different localized names of the item, in each language, available within the platform."}}},"ReportBranchdashboardenrollmentViewResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ReportBranchdashboardenrollmentViewData","description":"Branch statistics"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ReportBranchdashboardenrollmentViewLinks"}}}},"ReportBranchdashboardenrollmentViewData":{"required":["branch_name","items"],"properties":{"branch_name":{"type":"string","description":"The name of the selected branch"},"items":{"type":"array","description":"The performance for each branch","items":{"$ref":"#/definitions/ReportBranchdashboardenrollmentViewItems"}}}},"ReportBranchdashboardenrollmentViewItems":{"required":["id","title","has_children","total_users","enrolled","completed","in_progress","subscribed","overdue"],"properties":{"id":{"type":"integer","description":"The ID of the branch"},"title":{"type":"integer","description":"The name of the branch"},"has_children":{"type":"boolean","description":"True, if the branch has children. False if not."},"total_users":{"type":"integer","description":"The total users in the branch and sub-branches"},"enrolled":{"type":"integer","description":"The number of course enrollments"},"completed":{"type":"integer","description":"The number of course enrollments with the status &quot;completed&quot;"},"in_progress":{"type":"integer","description":"The number of course enrollments with the status &quot;in_progress&quot;"},"subscribed":{"type":"integer","description":"The number of course enrollments with the status &quot;subscribed&quot;"},"overdue":{"type":"integer","description":"The number of course enrollments that have overdue dates"}}},"ReportBranchdashboardenrollmentViewLinks":{},"ReportBranchdashboardenrollmentViewExportPdfSchema":{"type":"object","properties":{"images":{"type":"array","description":"An array of Base64 encoded images. This parameter is optional.","items":{"$ref":"#/definitions/ReportBranchdashboardenrollmentViewExportPdfImages"}},"hide_deactivated_users":{"type":"boolean","description":"If set to TRUE, inactive users will be excluded. Otherwise if set to FALSE inactive users will be shown in the report. This paramter is optional."}}},"ReportBranchdashboardenrollmentViewExportPdfImages":{},"ReportBranchdashboardenrollmentListResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ReportBranchdashboardenrollmentListData","description":"The Branch Enrollments statistics"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ReportBranchdashboardenrollmentListLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ReportBranchdashboardenrollmentListData":{"required":["items","count","cursor","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"The details of single enrollment","items":{"$ref":"#/definitions/ReportBranchdashboardenrollmentListItems"}},"count":{"type":"integer","description":"Total number of items returned"},"cursor":{"type":"string","description":"Unique ID used to temporarily store search parameters. Its value can be null"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ReportBranchdashboardenrollmentListSort"}}}},"ReportBranchdashboardenrollmentListItems":{"required":["username","fullname","course_name","course_type","enrollment_date","status","score","session_time","credits"],"properties":{"username":{"type":"string","description":"The username of the user"},"fullname":{"type":"string","description":"The full name of the user"},"course_name":{"type":"string","description":"The name of the course"},"course_code":{"type":"string","description":"The code of the course"},"course_type":{"description":"The course type. Possible values are &quot;elearning&quot; or &quot;classroom&quot;.","enum":["elearning","classroom"],"type":"string"},"enrollment_date":{"type":"string","format":"date","description":"The course enrollment date"},"completion_date":{"type":"string","format":"date","description":"The course completion date"},"status":{"description":"The enrollment status. Possible values are &quot;subscribed&quot;, &quot;in_progress&quot;, &quot;completed&quot;, &quot;waiting&quot;, &quot;subscription_to_confirm&quot;, &quot;suspended&quot; or &quot;overbooking&quot;.","enum":["subscribed","in_progress","completed","waiting","subscription_to_confirm","suspended","overbooking"],"type":"string"},"score":{"type":"integer","description":"The enrollment score"},"session_time":{"type":"integer","description":"The time spent in the course, displayed in seconds"},"credits":{"type":"integer","description":"The course credits"}}},"ReportBranchdashboardenrollmentListSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending"}}},"ReportBranchdashboardenrollmentListLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/ReportBranchdashboardenrollmentListSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/ReportBranchdashboardenrollmentListGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/ReportBranchdashboardenrollmentListFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/ReportBranchdashboardenrollmentListLast","description":"Link to the last page"}}},"ReportBranchdashboardenrollmentListSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"ReportBranchdashboardenrollmentListGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"ReportBranchdashboardenrollmentListFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"ReportBranchdashboardenrollmentListLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"ReportBranchdashboardenrollmentSummaryResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ReportBranchdashboardenrollmentSummaryData","description":"The branch statistics"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ReportBranchdashboardenrollmentSummaryLinks"}}}},"ReportBranchdashboardenrollmentSummaryData":{"required":["id","root","title","code","has_children","total_users","enrolled","completed","in_progress","subscribed"],"properties":{"id":{"type":"string","description":"The name of the selected branch"},"root":{"type":"boolean","description":"Returns &quot;TRUE&quot; if the branch is the root branch"},"title":{"type":"string","description":"The name of the selected branch"},"code":{"type":"string","description":"The code of the selected branch"},"has_children":{"type":"boolean","description":"Returns &quot;TRUE&quot; if the branch has children"},"total_users":{"type":"integer","description":"The count of total users in the branch and sub-branches"},"enrolled":{"type":"integer","description":"The number of course enrollments"},"completed":{"type":"integer","description":"The number of course enrollments with status &quot;completed&quot;"},"in_progress":{"type":"integer","description":"The number of course enrollments with status &quot;in_progress&quot;"},"subscribed":{"type":"integer","description":"The number of course enrollments with status &quot;subscribed&quot;"}}},"ReportBranchdashboardenrollmentSummaryLinks":{},"ReportMytranscriptMyTranscriptListResponse":{"required":["data","version","_links","extra_data","version"],"properties":{"data":{"$ref":"#/definitions/ReportMytranscriptMyTranscriptListData","description":"An object containing the returned my transcript details"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ReportMytranscriptMyTranscriptListLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"},"extra_data":{"$ref":"#/definitions/ReportMytranscriptMyTranscriptListExtraData","description":"Returned object containing extra information"}}},"ReportMytranscriptMyTranscriptListData":{"properties":{"count":{"type":"integer","required":"required","description":"Total number of items returned"},"cursor":{"type":"string","required":"optional","description":"Unique ID used to temporarily store search parameters. This field is to be considered as deprecated and it will be removed in a future release."},"has_more_data":{"type":"boolean","required":"required","description":"True if the current page is not the last page"},"current_page":{"type":"integer","required":"required","description":"Page number of the current page"},"current_page_size":{"type":"integer","required":"required","description":"Number of items per page"},"total_page_count":{"type":"integer","required":"optional","description":"Total number of pages returned"},"total_count":{"type":"integer","required":"optional","description":"Total number of Items"},"items":{"type":"array","description":"An array containing the list of my transcript","items":{"$ref":"#/definitions/ReportMytranscriptMyTranscriptListItems"}},"sort":{"type":"array","description":"A returned array of applied sorting fields","items":{"$ref":"#/definitions/ReportMytranscriptMyTranscriptListSort"}}},"required":["count","has_more_data","current_page","current_page_size","items","sort"]},"ReportMytranscriptMyTranscriptListLinks":{"properties":{"self":{"$ref":"#/definitions/ReportMytranscriptMyTranscriptListSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/ReportMytranscriptMyTranscriptListGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/ReportMytranscriptMyTranscriptListFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/ReportMytranscriptMyTranscriptListLast","description":"Link to the last page"},"next":{"$ref":"#/definitions/ReportMytranscriptMyTranscriptListNext","description":"Go to next page number"},"prev":{"$ref":"#/definitions/ReportMytranscriptMyTranscriptListPrev","description":"Go to previous page number"}},"required":["self","goto","first","last"]},"ReportMytranscriptMyTranscriptListSelf":{"properties":{"href":{"type":"string","required":"required","description":"Url of the current page"}},"required":["href"]},"ReportMytranscriptMyTranscriptListGoto":{"properties":{"href":{"type":"string","required":"required","description":"Url of the specific page"}},"required":["href"]},"ReportMytranscriptMyTranscriptListFirst":{"properties":{"href":{"type":"string","required":"required","description":"Url of the first page"}},"required":["href"]},"ReportMytranscriptMyTranscriptListLast":{"properties":{"href":{"type":"string","required":"required","description":"Url of the last page"}},"required":["href"]},"ReportMytranscriptMyTranscriptListNext":{"properties":{"href":{"type":"string","required":"required","description":"Url of the next page"}},"required":["href"]},"ReportMytranscriptMyTranscriptListPrev":{"properties":{"href":{"type":"string","required":"required","description":"Url of the previous page"}},"required":["href"]},"ReportMytranscriptMyTranscriptListItems":{"required":["id","name","slug","type","has_certificate","enrollment_date","enrollment_status"],"properties":{"id":{"type":"integer","description":"The my transcript record ID, unique with the type"},"name":{"type":"string","description":"The my transcript record name"},"slug":{"type":"string","description":"The my transcript record slug"},"type":{"description":"The my transcript record type. Possible values are &quot;elearning&quot;, &quot;classroom&quot; or &quot;learningplan&quot;.","enum":["elearning","classroom","learningplan"],"type":"string"},"has_certificate":{"type":"boolean","description":"TRUE if the my transcript has an assigned certificate, FALSE otherwise."},"certificate_url":{"type":"string","description":"The certificate URL of the record. Returned if the logged user has obtained the certificate for the transcription."},"enrollment_date":{"type":"string","format":"date","description":"The my transcript record enrollment date. Returned in UTC with yyyy-MM-dd HH:mm:ss format."},"enrollment_status":{"description":"The my transcript record enrollment status. Possible values are &quot;subscribed&quot;, &quot;in_progress&quot; or &quot;completed&quot;.","enum":["subscribed","in_progress","completed"],"type":"string"},"expiration_date":{"type":"string","format":"date","description":"The my transcript record expiration date. Returned in UTC with yyyy-MM-dd HH:mm:ss format."},"completion_date":{"type":"string","format":"date","description":"The my transcript record completion date. Returned in UTC with yyyy-MM-dd HH:mm:ss format."},"total_time":{"type":"integer","description":"The my transcript record total time"},"score":{"type":"integer","description":"The my transcript record score"},"credits":{"type":"integer","description":"The my transcript record credits"},"average_time":{"type":"integer","description":"The my transcript record total time"},"assigned_skills":{"type":"array","description":"An array containing the my transcript record&#039;s skills","items":{"$ref":"#/definitions/ReportMytranscriptMyTranscriptListAssignedSkills"}},"skill_count":{"type":"integer","description":"The record&#039;s skill count"}}},"ReportMytranscriptMyTranscriptListAssignedSkills":{"required":["name","description"],"properties":{"name":{"type":"string","description":"The skill name"},"description":{"type":"string","description":"The skill description"}}},"ReportMytranscriptMyTranscriptListSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"The sorting field name. Possible value is just &quot;name&quot;","enum":["name"],"type":"string"},"sort_dir":{"description":"The sorting direction. Possible values are: asc for ascending or desc for descending.","enum":["asc","desc"],"type":"string"}}},"ReportMytranscriptMyTranscriptListExtraData":{"required":["transcript_focus","total_credits"],"properties":{"transcript_focus":{"description":"The my transcript focus. Possible values are: &quot;training_oriented&quot;, &quot;continuous_education_oriented&quot; or &quot;skill_acquisition&quot;.","enum":["training_oriented","continuous_education_oriented","skill_acquisition"],"type":"string"},"total_credits":{"type":"integer","description":"The logged user total credits"}}},"ReportPolicyUsersResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ReportPolicyUsersData","description":"The response data"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ReportPolicyUsersLinks"}}}},"ReportPolicyUsersData":{"properties":{"items":{"type":"array","description":"The list of Users","items":{"$ref":"#/definitions/ReportPolicyUsersItems"}},"count":{"type":"integer","description":"Total number of items returned"},"cursor":{"type":"string","description":"Unique ID used to temporarily store search parameters"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ReportPolicyUsersSort"}},"query_id":{"type":"string","description":"The ID of the query"},"next_token":{"type":"string","description":"The token to recover the next chunk of data"}},"required":["count","cursor","has_more_data","current_page","current_page_size"]},"ReportPolicyUsersItems":{"required":["username","email","last_login","track_id","domain","policy_id","version_id","version","policy_name","policy_accepted","acceptance_date","user_id","firstname","lastname"],"properties":{"username":{"type":"string","description":"The user name of the user"},"email":{"type":"string","description":"The email address of the user"},"last_login":{"type":"string","description":"The last login date of the user"},"track_id":{"type":"string","description":"The tracking ID"},"domain":{"type":"string","description":"The domain"},"policy_id":{"type":"string","description":"The policy ID"},"version_id":{"type":"string","description":"The version ID"},"version":{"type":"string","description":"The version"},"policy_name":{"type":"string","description":"The privacy policy name"},"policy_accepted":{"type":"string","description":"Shows if the privacy policy is accepted"},"acceptance_date":{"type":"string","description":"Displays the acceptance date of the policy"},"user_id":{"type":"string","description":"The user ID"},"firstname":{"type":"string","description":"The first name of the user"},"lastname":{"type":"string","description":"The last name of the user"},"answer_sub_policy_1":{"type":"string","description":"The answer of the sub policy"},"answer_sub_policy_2":{"type":"string","description":"The answer of the sub policy"},"answer_sub_policy_3":{"type":"string","description":"The answer of the sub policy"}}},"ReportPolicyUsersSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending"}}},"ReportPolicyUsersLinks":{},"ReportPolicyPdfSchema":{"type":"object","properties":{"chart_1":{"type":"string","description":"The data URL of the chart image to be inserted into the PDF file. This paramter is optional."},"chart_2":{"type":"string","description":"The data URL of the chart image to be inserted into the PDF file. This paramter is optional."}}},"ReportPolicyReportByUserResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ReportPolicyReportByUserData","description":"Response data"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ReportPolicyReportByUserLinks"}}}},"ReportPolicyReportByUserData":{"properties":{"items":{"type":"array","description":"The list of Users","items":{"$ref":"#/definitions/ReportPolicyReportByUserItems"}},"count":{"type":"integer","description":"Total number of items returned"},"cursor":{"type":"string","description":"Unique ID used to temporarily store search parameters"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ReportPolicyReportByUserSort"}},"extra_data":{"$ref":"#/definitions/ReportPolicyReportByUserExtraData","description":"Extra data"}},"required":["count","cursor","has_more_data","current_page","current_page_size","extra_data"]},"ReportPolicyReportByUserItems":{"required":["username","email","last_login","track_id","domain","policy_id","version_id","version","policy_name","policy_accepted","acceptance_date"],"properties":{"username":{"type":"string","description":"The user name of the user"},"email":{"type":"string","description":"The email of the user"},"last_login":{"type":"string","description":"The last login date of the user"},"track_id":{"type":"string","description":"The tracking ID"},"domain":{"type":"string","description":"The domain"},"policy_id":{"type":"string","description":"The policy ID"},"version_id":{"type":"string","description":"The version ID"},"version":{"type":"string","description":"The version"},"policy_name":{"type":"string","description":"The privacy policy name"},"policy_accepted":{"type":"string","description":"Shows if the privacy policy is accepted"},"acceptance_date":{"type":"string","description":"The acceptance date of the Policy"},"user_id":{"type":"string","description":"The user ID"},"firstname":{"type":"string","description":"The first name of the user"},"lastname":{"type":"string","description":"The last name of the user"},"answer_sub_policy_1":{"type":"string","description":"The answer to the sub policy"},"answer_sub_policy_2":{"type":"string","description":"The answer to the sub policy"},"answer_sub_policy_3":{"type":"string","description":"The answer to the sub policy"}}},"ReportPolicyReportByUserSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending"}}},"ReportPolicyReportByUserExtraData":{"required":["user_data","additional_fields","branches","saml_settings"],"properties":{"user_data":{"$ref":"#/definitions/ReportPolicyReportByUserUserData","description":""},"additional_fields":{"type":"array","description":"","items":{"$ref":"#/definitions/ReportPolicyReportByUserAdditionalFields"}},"branches":{"type":"array","description":"","items":{"$ref":"#/definitions/ReportPolicyReportByUserBranches"}},"saml_settings":{"$ref":"#/definitions/ReportPolicyReportByUserSamlSettings","description":""}}},"ReportPolicyReportByUserUserData":{"required":["user_id","username","first_name","last_name","email","uuid","lang_code","lang_browsercode","avatar","force_change","expiration","language","level","date_format","timezone","email_validation_status","valid","manager_first_name","manager_last_name","manager_username","manager_id","can_manage_subordinates","is_saml_provision","cant_have_direct_manager"],"properties":{"user_id":{"type":"integer","description":"The user ID or user name of the user"},"username":{"type":"string","description":"The username of the user"},"first_name":{"type":"string","description":"The first name of the user"},"last_name":{"type":"string","description":"The last name of the user"},"email":{"type":"string","description":"The email address of the user"},"uuid":{"type":"string","description":"The UUID (universally unique identifier) of the user"},"lang_code":{"type":"string","description":"User UI language code"},"lang_browsercode":{"type":"string","description":"User UI language browser code"},"avatar":{"type":"string","description":"The avatar of the user"},"force_change":{"type":"string","description":"Shows if the user is forced to change their password"},"expiration":{"type":"string","format":"date","description":"The expiration date of a user. This item is available only for users that are NOT pending."},"language":{"type":"string","description":"User UI language. This field is deprecated and it will be dropped on 2018-07-31"},"level":{"type":"integer","description":"The level of a user. This item is available only for users that are NOT pending."},"date_format":{"type":"string","description":"The date format (for example: &#039;ar&#039;, &#039;ar_dz&#039;, &#039;bg&#039;, &#039;en&#039;, &#039;en-gb&#039;, &#039;it&#039;, &#039;es&#039;, etc.)"},"timezone":{"type":"string","description":"The time zone (for example: &#039;Europe/Rome&#039;)"},"email_validation_status":{"type":"integer","description":"The email validation status of an user. This item is available only for users that are NOT pending."},"valid":{"type":"integer","description":"Displays &quot;0&quot; if the user is inactive or &quot;1&quot; if the user is active."},"manager_first_name":{"type":"string","description":"The manager&#039;s first name. This item is available only for users that are NOT pending."},"manager_last_name":{"type":"string","description":"The manager&#039;s last name. This item is available only for users that are NOT pending."},"manager_username":{"type":"string","description":"The manager&#039;s user name. This item is available only for users that are NOT pending."},"manager_id":{"type":"string","description":"Manager id. It is available only for NOT pending users"},"can_manage_subordinates":{"type":"boolean","description":"Set to TRUE if the user can manage subordinates, otherwise returns FALSE. This item is available only for users that are NOT pending."},"is_saml_provision":{"type":"string","description":"Is SAML provision"},"cant_have_direct_manager":{"type":"boolean","description":"The user can&#039;t have a direct manager"}}},"ReportPolicyReportByUserAdditionalFields":{"required":["id","type","title","settings","mandatory","invisible_to_user","value","sequence"],"properties":{"id":{"type":"integer","description":"The field ID"},"type":{"description":"Type of the field","enum":["dropdown","textfield","date"],"type":"string"},"title":{"type":"string","description":"The field title"},"settings":{"type":"string","description":"Settings of the additional field"},"mandatory":{"type":"integer","description":"Returns 1 if the field is mandatory, otherwise returns 0."},"invisible_to_user":{"type":"integer","description":"Returns 1 if the field is invisible to an regular users, otherwise returns 0."},"value":{"type":"string","description":"Chosen value by user"},"download_url":{"type":"string","description":"The URL of the downloadable file. This is available only for UPLOAD fields."},"sequence":{"type":"integer","description":"the order of appearance of the additional field"},"options":{"$ref":"#/definitions/ReportPolicyReportByUserOptions","description":"The dropdown options if field type is set to &quot;dropdown&quot; or &quot;country&quot;"}}},"ReportPolicyReportByUserOptions":{"required":["id","label"],"properties":{"id":{"type":"integer","description":"The option ID"},"label":{"type":"string","description":"The option title"}}},"ReportPolicyReportByUserBranches":{"properties":{"id":{"type":"integer","description":"Branch ID"},"iLeft":{"type":"integer","description":"Branch iLeft"},"iRight":{"type":"integer","description":"Branch iRight"}}},"ReportPolicyReportByUserSamlSettings":{"required":["unique_field","lock_provisioned_user_fields","provisioned_user_fields","multidomain"],"properties":{"unique_field":{"type":"string","description":"Unique field"},"lock_provisioned_user_fields":{"type":"integer","description":"If this value returns 1 then provisioned user fields are locked, ie. set to read only. Otherwise returns 0."},"provisioned_user_fields":{"type":"array","description":"Returns users provisioning fields from SAML Settings. The &quot;key&quot; in the array is a field name, the &quot;value&quot; is an attribute statement.","items":{"$ref":"#/definitions/ReportPolicyReportByUserProvisionedUserFields"}},"multidomain":{"$ref":"#/definitions/ReportPolicyReportByUserMultidomain","description":"Returns the first multidomain found for a user in the path of the associated branch (or branches)."},"query_id":{"type":"string","description":"The ID of the query"},"next_token":{"type":"string","description":"The token to recover the next chunk of data"}}},"ReportPolicyReportByUserProvisionedUserFields":{},"ReportPolicyReportByUserMultidomain":{},"ReportPolicyReportByUserLinks":{},"ReportPolicyUserTrackingResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ReportPolicyUserTrackingData","description":"The response data"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ReportPolicyUserTrackingLinks"}}}},"ReportPolicyUserTrackingData":{"required":["policy_data"],"properties":{"policy_data":{"$ref":"#/definitions/ReportPolicyUserTrackingPolicyData","description":"The privacy policy data"}}},"ReportPolicyUserTrackingPolicyData":{"required":["policy_id","policy_name","policy_acceptance_message","policy_body","policy_answer","sub_policies","user_data"],"properties":{"policy_id":{"type":"integer","description":"The policy ID"},"policy_name":{"$ref":"#/definitions/ReportPolicyUserTrackingPolicyName","description":"The name of the policy in all languages"},"policy_acceptance_message":{"$ref":"#/definitions/ReportPolicyUserTrackingPolicyAcceptanceMessage","description":"The acceptance message of the policy for all languages"},"policy_body":{"$ref":"#/definitions/ReportPolicyUserTrackingPolicyBody","description":"The body of the policy for all languages"},"policy_answer":{"type":"string","description":"Returns the privacy policy acceptance status."},"sub_policies":{"type":"array","description":"List of sub policies for this policy","items":{"$ref":"#/definitions/ReportPolicyUserTrackingSubPolicies"}},"user_data":{"$ref":"#/definitions/ReportPolicyUserTrackingUserData","description":"User data"}}},"ReportPolicyUserTrackingPolicyName":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code; the value is the translation."}}},"ReportPolicyUserTrackingPolicyAcceptanceMessage":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code; the value is the translation."}}},"ReportPolicyUserTrackingPolicyBody":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code; the value is the translation."}}},"ReportPolicyUserTrackingSubPolicies":{"required":["sub_policy_id","mandatory","sub_policy_acceptance_message","sub_policy_answer"],"properties":{"sub_policy_id":{"type":"integer","description":"The sub policy ID"},"mandatory":{"type":"integer","description":"Returns 1 if the sub policy is mandatory, returns 0 if the sub policy is optional."},"sub_policy_acceptance_message":{"$ref":"#/definitions/ReportPolicyUserTrackingSubPolicyAcceptanceMessage","description":"The acceptance message of the sub policy for all languages"},"sub_policy_answer":{"type":"string","description":"Returns the sub-policy acceptance status."}}},"ReportPolicyUserTrackingSubPolicyAcceptanceMessage":{"properties":{"xx":{"type":"string","description":"The key XX is the language code; the value is the translation."}}},"ReportPolicyUserTrackingUserData":{"required":["user_data","additional_fields","branches","saml_settings"],"properties":{"user_data":{"$ref":"#/definitions/ReportPolicyUserTrackingUserDataL2","description":""},"additional_fields":{"type":"array","description":"","items":{"$ref":"#/definitions/ReportPolicyUserTrackingAdditionalFields"}},"branches":{"type":"array","description":"","items":{"$ref":"#/definitions/ReportPolicyUserTrackingBranches"}},"saml_settings":{"$ref":"#/definitions/ReportPolicyUserTrackingSamlSettings","description":""}}},"ReportPolicyUserTrackingUserDataL2":{"required":["user_id","username","first_name","last_name","email","uuid","lang_code","lang_browsercode","avatar","force_change","expiration","level","date_format","timezone","email_validation_status","valid","manager_first_name","manager_last_name","manager_username","manager_id","can_manage_subordinates","language","is_saml_provision","cant_have_direct_manager"],"properties":{"user_id":{"type":"integer","description":"User ID or user name of the user"},"username":{"type":"string","description":"The user name of the user"},"first_name":{"type":"string","description":"The first name of the user"},"last_name":{"type":"string","description":"The last name of the user"},"email":{"type":"string","description":"The email address of the user"},"uuid":{"type":"string","description":"The UUID (universally unique identifier) of the user"},"lang_code":{"type":"string","description":"User UI language code"},"lang_browsercode":{"type":"string","description":"User UI language browser code"},"avatar":{"type":"string","description":"The avatar of the user"},"force_change":{"type":"string","description":"Shows if the user is forced to change their password"},"expiration":{"type":"string","format":"date","description":"The expiration date of a user. This item is available only for users that are NOT pending."},"level":{"type":"integer","description":"The level of a user. This item is available only for users that are NOT pending."},"date_format":{"type":"string","description":"The date format (for example: &#039;ar&#039;, &#039;ar_dz&#039;, &#039;bg&#039;, &#039;en&#039;, &#039;en-gb&#039;, &#039;it&#039;, &#039;es&#039;, etc.)"},"timezone":{"type":"string","description":"The time zone (for example: &#039;Europe/Rome&#039;)"},"email_validation_status":{"type":"integer","description":"The email validation status of an user. This item is available only for users that are NOT pending."},"valid":{"type":"integer","description":"Is user active. Displays &quot;0&quot; if the user is inactive or &quot;1&quot; if the user is active."},"manager_first_name":{"type":"string","description":"The manager&#039;s first name. This item is available only for users that are NOT pending."},"manager_last_name":{"type":"string","description":"The manager&#039;s last name. This item is available only for users that are NOT pending."},"manager_username":{"type":"string","description":"The manager&#039;s user name. This item is available only for users that are NOT pending."},"manager_id":{"type":"string","description":"Manager id. It is available only for NOT pending users"},"can_manage_subordinates":{"type":"boolean","description":"Set to TRUE if the user can manage subordinates, otherwise returns FALSE. This item is available only for users that are NOT pending."},"language":{"type":"string","description":"User UI language. This field is deprecated and it will be dropped on 2018-07-31"},"is_saml_provision":{"type":"string","description":"Is SAML provision"},"cant_have_direct_manager":{"type":"boolean","description":"The user can&#039;t have a direct manager"}}},"ReportPolicyUserTrackingAdditionalFields":{"required":["id","title","type","settings","mandatory","invisible_to_user","value","sequence","enabled"],"properties":{"id":{"type":"integer","description":"The field ID"},"title":{"type":"string","description":"The field title"},"type":{"description":"Type of the field","enum":["dropdown","textfield","date"],"type":"string"},"settings":{"type":"string","description":"Settings of the additional field"},"mandatory":{"type":"integer","description":"Returns 1 if the field is mandatory, otherwise returns 0."},"invisible_to_user":{"type":"integer","description":"Returns 1 if the field is invisible to an regular users, otherwise returns 0."},"value":{"type":"string","description":"Chosen value by user"},"sequence":{"type":"integer","description":"the order of appearance of the additional field"},"enabled":{"type":"boolean","description":"additional field enabled"},"download_url":{"type":"string","description":"The URL of the downloadable file. This is available only for UPLOAD fields."},"options":{"$ref":"#/definitions/ReportPolicyUserTrackingOptions","description":"The dropdown options if field type is set to &quot;dropdown&quot; or &quot;country&quot;"}}},"ReportPolicyUserTrackingOptions":{"required":["id","label"],"properties":{"id":{"type":"integer","description":"The option ID"},"label":{"type":"string","description":"The option title"}}},"ReportPolicyUserTrackingBranches":{"properties":{"id":{"type":"integer","description":"Branch ID"},"iLeft":{"type":"integer","description":"Branch iLeft"},"iRight":{"type":"integer","description":"Branch iRight"}}},"ReportPolicyUserTrackingSamlSettings":{"required":["unique_field","lock_provisioned_user_fields","provisioned_user_fields","multidomain"],"properties":{"unique_field":{"type":"string","description":"Unique field"},"lock_provisioned_user_fields":{"type":"integer","description":"If this value returns 1 then provisioned user fields are locked, ie. set to read only. Otherwise returns 0."},"provisioned_user_fields":{"type":"array","description":"Returns users provisioning fields from SAML Settings. The &quot;key&quot; in the array is a field name, the &quot;value&quot; is an attribute statement.","items":{"$ref":"#/definitions/ReportPolicyUserTrackingProvisionedUserFields"}},"multidomain":{"type":"array","description":"Returns the first multidomain found for a user in the path of the associated branch (or branches).","items":{"$ref":"#/definitions/ReportPolicyUserTrackingMultidomain"}}}},"ReportPolicyUserTrackingProvisionedUserFields":{},"ReportPolicyUserTrackingMultidomain":{},"ReportPolicyUserTrackingLinks":{},"ReportQuerybuilderIndexResponse":{"required":["data","version","_links","version"],"properties":{"data":{"type":"array","description":"The list of reports","items":{"$ref":"#/definitions/ReportQuerybuilderIndexData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ReportQuerybuilderIndexLinks"}}}},"ReportQuerybuilderIndexData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"The list of reports","items":{"$ref":"#/definitions/ReportQuerybuilderIndexItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Unique ID used to temporarily store search parameters"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ReportQuerybuilderIndexSort"}}}},"ReportQuerybuilderIndexItems":{"required":["id","title","last_edit","last_edit_by","filter_data","actions"],"properties":{"id":{"type":"integer","description":"The ID of the &#039;Query Builder&#039; report"},"title":{"type":"string","description":"The title of the report"},"last_edit":{"type":"string","format":"date","description":"The date of the last report edit"},"last_edit_by":{"type":"string","description":"The user name of the last user who edited the report"},"filter_data":{"type":"string","description":"The JSON-encoded Query Builder parameters"},"actions":{"type":"array","description":"Actions that current user can perform, for example: &quot;delete&quot; or &quot;edit&quot;","items":{"type":"string"}}}},"ReportQuerybuilderIndexSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending"}}},"ReportQuerybuilderIndexLinks":{},"ReportQuerybuilderAnalyzeSchema":{"type":"object","required":["sql"],"properties":{"sql":{"type":"string","description":"The SQL to be analyzed"},"run_sql":{"type":"boolean","description":"If set to TRUE it will run the SQL statment &quot;EXPLAIN&quot;. The default value is FALSE."},"sql_params_values":{"$ref":"#/definitions/ReportQuerybuilderAnalyzeSqlParamsValues","description":"The SQL parameters starting with &#039;:&#039; PLEASE NOTE: This parameter is required if the parsed SQL contains fields starting with &#039;:&#039;. For example: { &quot;sql_params_values&quot;: {&quot;:param_1&quot;: {&quot;value&quot;: 13010,&quot;type&quot;: &quot;integer&quot;},&quot;:param_2&quot;: {&quot;value&quot;: &quot;some string&quot;,&quot;type&quot;: &quot;string&quot;}} }"}}},"ReportQuerybuilderAnalyzeSqlParamsValues":{},"ReportQuerybuilderAnalyzeResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ReportQuerybuilderAnalyzeData","description":"The ID of the new record"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ReportQuerybuilderAnalyzeLinks"}}}},"ReportQuerybuilderAnalyzeData":{"required":["explain_sql","sql","selected_fields","binded_params"],"properties":{"explain_sql":{"type":"array","description":"The result of the execution of &#039;EXPLAIN&#039; SQL statment","items":{"type":"object"}},"sql":{"type":"string","description":"SQL"},"selected_fields":{"type":"array","description":"The fields from SELECT statement","items":{"type":"string"}},"binded_params":{"type":"array","description":"The array with binded SQL parameters","items":{"$ref":"#/definitions/ReportQuerybuilderAnalyzeBindedParams"}}}},"ReportQuerybuilderAnalyzeBindedParams":{"required":["type","name"],"properties":{"type":{"type":"string","description":"The type of the parameter (parameters starting with &#039;:&#039;)"},"name":{"type":"string","description":"The name of the parameter (parameters starting with &#039;:&#039; next to type)"}}},"ReportQuerybuilderAnalyzeLinks":{},"ReportQuerybuilderViewResponse":{"required":["data","version","_links","version"],"properties":{"data":{"type":"array","description":"The data for the query builder plan","items":{"$ref":"#/definitions/ReportQuerybuilderViewData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ReportQuerybuilderViewLinks"}}}},"ReportQuerybuilderViewData":{"required":["id","title","creation_date","filter_data"],"properties":{"id":{"type":"integer","description":"The ID of the &#039;Query Builder&#039; report"},"title":{"type":"string","description":"The title of the report"},"creation_date":{"type":"string","format":"date","description":"The date of the report creation"},"filter_data":{"type":"string","description":"The JSON-encoded Query Builder parameters"}}},"ReportQuerybuilderViewLinks":{},"ReportQuerybuilderCreateSchema":{"type":"object","required":["name","sql","sql_params_values","sql_fields"],"properties":{"name":{"type":"string","description":"The report name. This parameter is mandatory."},"sql":{"type":"string","description":"The SQL to be saved. This parameter is mandatory."},"sql_params_values":{"$ref":"#/definitions/ReportQuerybuilderCreateSqlParamsValues","description":"The SQL parameters starting with &#039;:&#039;. PLEASE NOTE: This parameter is required if the parsed SQL contains fields starting with &#039;:&#039;, for example: { &quot;sql_params_values&quot;: {&quot;:param_1&quot;: {&quot;value&quot;: 13010,&quot;type&quot;: &quot;integer&quot;, &quot;name&quot;: &quot;param_name_1&quot;},&quot;:param_2&quot;: {&quot;value&quot;: &quot;some string&quot;,&quot;type&quot;: &quot;string&quot;, &quot;name&quot;: &quot;param_name_2&quot;}} }"},"sql_fields":{"$ref":"#/definitions/ReportQuerybuilderCreateSqlFields","description":"The SQL selected fields, for example: { &quot;sql_fields&quot;: {&quot;idst&quot;: {&quot;name&quot;: &quot;id of user&quot;}, &quot;firstname&quot;: {&quot;name&quot;: &quot;first name of user&quot;}} }"}}},"ReportQuerybuilderCreateSqlParamsValues":{},"ReportQuerybuilderCreateSqlFields":{},"ReportQuerybuilderCreateResponse":{"required":["data","version","_links","version"],"properties":{"data":{"type":"array","description":"Information about the created report","items":{"$ref":"#/definitions/ReportQuerybuilderCreateData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ReportQuerybuilderCreateLinks"}}}},"ReportQuerybuilderCreateData":{"required":["id"],"properties":{"id":{"type":"integer","description":"The ID of the created report"}}},"ReportQuerybuilderCreateLinks":{},"ReportQuerybuilderUpdateSchema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the report"},"sql":{"type":"string","description":"The SQL to be saved"},"sql_params_values":{"$ref":"#/definitions/ReportQuerybuilderUpdateSqlParamsValues","description":"Required if SQL parameter is used. The SQL parameters starting with &#039;:&#039; PLEASE NOTE: this parameter is required if parsed SQL contains fields starting with &#039;:&#039;, for example: { &quot;sql_params_values&quot;: {&quot;:param_1&quot;: {&quot;value&quot;: 13010,&quot;type&quot;: &quot;integer&quot;, &quot;name&quot;: &quot;param_name_1&quot;},&quot;:param_2&quot;: {&quot;value&quot;: &quot;some string&quot;,&quot;type&quot;: &quot;string&quot;, &quot;name&quot;: &quot;param_name_2&quot;}} }"},"sql_fields":{"$ref":"#/definitions/ReportQuerybuilderUpdateSqlFields","description":"The SQL selected fields, for example: { &quot;sql_fields&quot;: {&quot;idst&quot;: {&quot;name&quot;: &quot;id of user&quot;}, &quot;firstname&quot;: {&quot;name&quot;: &quot;first name of user&quot;}} }"}},"required":["sql_fields"]},"ReportQuerybuilderUpdateSqlParamsValues":{},"ReportQuerybuilderUpdateSqlFields":{},"ReportQuerybuilderUpdateResponse":{"required":["data","version","_links","version"],"properties":{"data":{"type":"array","description":"Information about the updated report","items":{"$ref":"#/definitions/ReportQuerybuilderUpdateData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ReportQuerybuilderUpdateLinks"}}}},"ReportQuerybuilderUpdateData":{"required":["updated_id"],"properties":{"updated_id":{"type":"integer","description":"The ID of the updated report"}}},"ReportQuerybuilderUpdateLinks":{},"ReportQuerybuilderDeleteResponse":{"required":["data","version","_links","version"],"properties":{"data":{"type":"array","description":"Information about the deleted report","items":{"$ref":"#/definitions/ReportQuerybuilderDeleteData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ReportQuerybuilderDeleteLinks"}}}},"ReportQuerybuilderDeleteData":{"required":["deleted_id"],"properties":{"deleted_id":{"type":"integer","description":"The ID of deleted report"}}},"ReportQuerybuilderDeleteLinks":{},"ReportQuerybuilderDeleteMultipleSchema":{"type":"object","required":["ids"],"properties":{"ids":{"type":"array","description":"The array of report IDs","items":{"type":"integer"}}}},"ReportQuerybuilderDeleteMultipleResponse":{"required":["data","version","_links","version"],"properties":{"data":{"type":"array","description":"Information about the deleted report","items":{"$ref":"#/definitions/ReportQuerybuilderDeleteMultipleData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ReportQuerybuilderDeleteMultipleLinks"}}}},"ReportQuerybuilderDeleteMultipleData":{"required":["deleted_ids"],"properties":{"deleted_ids":{"type":"array","description":"IDs of deleted reports","items":{"type":"integer"}},"not_deleted_ids":{"type":"array","description":"IDs of NOT deleted reports","items":{"type":"integer"}}}},"ReportQuerybuilderDeleteMultipleLinks":{},"ReportQuerybuilderExecuteSqlSchema":{"type":"object","required":["sql"],"properties":{"sql":{"type":"string","description":"The SQL to be executed"},"sql_params_values":{"$ref":"#/definitions/ReportQuerybuilderExecuteSqlSqlParamsValues","description":"SQL parameters starting with &#039;:&#039; PLEASE NOTE: This parameter is required if parsed SQL contains fields starting with &#039;:&#039;, for example: { &quot;sql_params_values&quot;: {&quot;:param_1&quot;: {&quot;value&quot;: 13010,&quot;type&quot;: &quot;integer&quot;},&quot;:param_2&quot;: {&quot;value&quot;: &quot;some string&quot;,&quot;type&quot;: &quot;string&quot;}} }"}}},"ReportQuerybuilderExecuteSqlSqlParamsValues":{},"ReportQuerybuilderExecuteSqlData":{},"ReportQuerybuilderExecuteSqlResponse":{"properties":{"data":{"type":"array","description":"The query result, limited to 10 items","items":{"$ref":"#/definitions/ReportQuerybuilderExecuteSqlData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ReportQuerybuilderExecuteSqlLinks"}}},"required":["version","_links","version"]},"ReportQuerybuilderExecuteSqlLinks":{},"ReportReportReportsListResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ReportReportReportsListData","description":"Response data"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ReportReportReportsListLinks"}}}},"ReportReportReportsListData":{"required":["report_list"],"properties":{"report_list":{"type":"array","description":"The list of reports","items":{"$ref":"#/definitions/ReportReportReportsListReportList"}}}},"ReportReportReportsListReportList":{"required":["id_filter","report_type_id","author","creation_date","filter_name","is_public","views","idst","userid"],"properties":{"id_filter":{"type":"integer","description":"The ID of the report"},"report_type_id":{"type":"integer","description":"Type ID for this report"},"author":{"type":"integer","description":"The internal user ID number of the author"},"creation_date":{"type":"string","format":"date","description":"The timestamp (UTC) of the report creation"},"filter_name":{"type":"string","description":"The name of the filter"},"is_public":{"type":"boolean","description":"Returns TRUE if this is a public report, otherwise it returns FALSE"},"views":{"type":"integer","description":"The number of views"},"idst":{"type":"integer","description":"The internal user ID of the author"},"userid":{"type":"string","description":"The user name of the author"}}},"ReportReportReportsListLinks":{},"ReportReportReportCountRowsResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ReportReportReportCountRowsData","description":"Response data"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ReportReportReportCountRowsLinks"}}}},"ReportReportReportCountRowsData":{"required":["count"],"properties":{"count":{"type":"integer","description":"The number of rows matching the specified filters."}}},"ReportReportReportCountRowsLinks":{},"ReportReportReportFetchRowsResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ReportReportReportFetchRowsData","description":"Response data"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ReportReportReportFetchRowsLinks"}}}},"ReportReportReportFetchRowsData":{"required":["rows"],"properties":{"rows":{"type":"array","description":"The list of rows extracted from the custom report.","items":{"$ref":"#/definitions/ReportReportReportFetchRowsRows"}}}},"ReportReportReportFetchRowsRows":{},"ReportReportReportFetchRowsLinks":{},"ReportTermsUsersResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ReportTermsUsersData","description":"The response data"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ReportTermsUsersLinks"}}}},"ReportTermsUsersData":{"properties":{"items":{"type":"array","description":"The list of users","items":{"$ref":"#/definitions/ReportTermsUsersItems"}}}},"ReportTermsUsersItems":{"required":["username","email","last_login","track_id","domain","tc_id","version_id","version","tc_name","tc_accepted","acceptance_date","user_id","firstname","lastname"],"properties":{"username":{"type":"string","description":"The username of the user"},"email":{"type":"string","description":"Email of the user"},"last_login":{"type":"string","description":"The last login date of the user"},"track_id":{"type":"string","description":"The tracking ID"},"domain":{"type":"string","description":"The domain"},"tc_id":{"type":"string","description":"The Terms &amp; Conditions record ID"},"version_id":{"type":"string","description":"The version ID"},"version":{"type":"string","description":"The version"},"tc_name":{"type":"string","description":"The Terms &amp; Conditions record name"},"tc_accepted":{"type":"string","description":"Specifies if the terms and conditions are accepted"},"acceptance_date":{"type":"string","description":"The acceptance date of the Terms &amp; Conditions"},"user_id":{"type":"string","description":"The user ID"},"firstname":{"type":"string","description":"The first name of the user"},"lastname":{"type":"string","description":"The last name of the user"}}},"ReportTermsUsersLinks":{},"ReportTermsPdfSchema":{"type":"object","properties":{"chart_1":{"type":"string","description":"The data URL of Chart image to be inserted in PDF file"},"chart_2":{"type":"string","description":"The data URL of Chart image to be inserted in PDF file"}}},"ReportTermsPdfResponse":{"required":["_links","version"],"properties":{"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ReportTermsPdfLinks"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ReportTermsPdfLinks":{},"ReportTermsReportByUserResponse":{"required":["data","version","extra_data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ReportTermsReportByUserData","description":"The response data"},"version":{"type":"string","required":"required","description":"Current API version"},"extra_data":{"$ref":"#/definitions/ReportTermsReportByUserExtraData","description":"Extra data"},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ReportTermsReportByUserLinks"}}}},"ReportTermsReportByUserData":{"properties":{"items":{"type":"array","description":"A list of Users","items":{"$ref":"#/definitions/ReportTermsReportByUserItems"}}}},"ReportTermsReportByUserItems":{"required":["username","last_login","track_id","domain","tc_id","version_id","version","tc_name","tc_accepted","acceptance_date"],"properties":{"username":{"type":"string","description":"The username of the user"},"last_login":{"type":"string","description":"The last login date of the user"},"track_id":{"type":"string","description":"The tracking ID"},"domain":{"type":"string","description":"The domain"},"tc_id":{"type":"string","description":"The Terms &amp; Conditions record ID"},"version_id":{"type":"string","description":"The Version ID"},"version":{"type":"string","description":"The Version"},"tc_name":{"type":"string","description":"The Terms &amp; Conditions record name"},"tc_accepted":{"type":"string","description":"Indicates if the terms and conditions are accepted"},"acceptance_date":{"type":"string","description":"The acceptance date of the terms and conditions"},"user_id":{"type":"string","description":"The user ID"},"firstname":{"type":"string","description":"The first name of the user"},"lastname":{"type":"string","description":"The last name of the user"}}},"ReportTermsReportByUserExtraData":{"required":["user_data","additional_fields","saml_settings"],"properties":{"user_data":{"$ref":"#/definitions/ReportTermsReportByUserUserData","description":"User data"},"additional_fields":{"type":"array","description":"","items":{"$ref":"#/definitions/ReportTermsReportByUserAdditionalFields"}},"saml_settings":{"$ref":"#/definitions/ReportTermsReportByUserSamlSettings","description":""}}},"ReportTermsReportByUserUserData":{"required":["user_id","username","first_name","last_name","email","uuid","avatar","lang_code","lang_browsercode","is_saml_provision","language","manager_id","cant_have_direct_manager","force_change","expiration","level","date_format","timezone","email_validation_status","valid","manager_first_name","manager_last_name","manager_username","can_manage_subordinates","newsletter_optout","newsletter_optout_date"],"properties":{"user_id":{"type":"integer","description":"The user ID or username of the user"},"username":{"type":"string","description":"The username of the user"},"first_name":{"type":"string","description":"The first name of the user"},"last_name":{"type":"string","description":"The last name of the user"},"email":{"type":"string","description":"The email address of the user"},"uuid":{"type":"string","description":"The UUID (universally unique identifier) of the user"},"avatar":{"type":"string","description":"The Avatar of the user"},"lang_code":{"type":"string","description":"User UI language code"},"lang_browsercode":{"type":"string","description":"User UI language browser code"},"is_saml_provision":{"type":"string","description":"Is SAML provision"},"language":{"type":"string","description":"User UI language. This field is deprecated and it will be dropped on 2018-07-31"},"manager_id":{"type":"string","description":"Manager id. It is available only for NOT pending users"},"cant_have_direct_manager":{"type":"boolean","description":"The user can&#039;t have a direct manager"},"force_change":{"type":"string","description":"Force the user to change their password"},"expiration":{"type":"string","format":"date","description":"The expiration date of an user. This is available only for NOT pending users."},"level":{"type":"integer","description":"The level of a user. This is available only for NOT pending users."},"date_format":{"type":"string","description":"The date format, for example: &#039;ar&#039;, &#039;ar_dz&#039;, &#039;bg&#039;, &#039;en&#039;, &#039;en-gb&#039;, &#039;it&#039;, &#039;es&#039;"},"timezone":{"type":"string","description":"The timezone, for example: &#039;Europe/Rome&#039;"},"email_validation_status":{"type":"integer","description":"The email validation status of a user. This is available only for NOT pending users."},"valid":{"type":"integer","description":"Indicates if a user is active. Possible values are 0 for not active or 1 for active."},"manager_first_name":{"type":"string","description":"The manager first name. This is available only for NOT pending users."},"manager_last_name":{"type":"string","description":"The manager last name. This is available only for NOT pending users."},"manager_username":{"type":"string","description":"The manager username. This is available only for NOT pending users."},"can_manage_subordinates":{"type":"boolean","description":"Indicates if the user can manage subordinates. This is available only for NOT pending users."},"newsletter_optout":{"type":"string","description":"User opt out choice. Always False if TOGGLE/NEWSLETTER/OPT-OUT is not active or opt_out_mode setting is disabled"},"newsletter_optout_date":{"type":"string","description":"User opt out date. Always null if TOGGLE/NEWSLETTER/OPT-OUT is not active or opt_out_mode setting is disabled"}}},"ReportTermsReportByUserAdditionalFields":{"required":["id","title","type","mandatory","invisible_to_user","value","settings","sequence","enabled"],"properties":{"id":{"type":"integer","description":"The field ID"},"title":{"type":"string","description":"The field title"},"type":{"type":"string","description":"Field type"},"mandatory":{"type":"integer","description":"Indicates if the field is mandatory. Possible values are 0 for false or 1 for true."},"invisible_to_user":{"type":"integer","description":"Indicates if the field is invisible to a regular user. Possible values are 0 for false or 1 for true."},"value":{"type":"string","description":"Chosen value by the user"},"settings":{"type":"string","description":"The setting of the IFRAME type field"},"sequence":{"type":"integer","description":"the order of appearance of the additional field"},"enabled":{"type":"boolean","description":"additional field enabled"},"download_url":{"type":"string","description":"The URL of the downloadable file. This item is only availabel for UPLOAD fields."},"options":{"$ref":"#/definitions/ReportTermsReportByUserOptions","description":"The dropdown options if the field type is &#039;dropdown&#039; or &#039;country&#039;"}}},"ReportTermsReportByUserOptions":{"required":["id","label"],"properties":{"id":{"type":"integer","description":"The option ID"},"label":{"type":"string","description":"The option title"}}},"ReportTermsReportByUserSamlSettings":{"required":["unique_field","lock_provisioned_user_fields","provisioned_user_fields","multidomain"],"properties":{"unique_field":{"type":"string","description":"The unique field"},"lock_provisioned_user_fields":{"type":"integer","description":"Indicates if provisioned user fields are locked.  Possible values are 0 for false or 1 for true.  If this item is true then provisioned fields are read only."},"provisioned_user_fields":{"type":"array","description":"Users provisioning fields from SAML Settings, the &#039;key&#039; in array is a Field name, the &#039;value&#039; is the Attribute statement","items":{"$ref":"#/definitions/ReportTermsReportByUserProvisionedUserFields"}},"multidomain":{"type":"array","description":"For a user it returns the first multidomain found in the path to the associated branch (or branches).","items":{"$ref":"#/definitions/ReportTermsReportByUserMultidomain"}}}},"ReportTermsReportByUserProvisionedUserFields":{},"ReportTermsReportByUserMultidomain":{},"ReportTermsReportByUserLinks":{},"ReportTermsUserTrackingResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ReportTermsUserTrackingData","description":"The response data"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ReportTermsUserTrackingData":{"required":["tc_data","user_data"],"properties":{"tc_data":{"$ref":"#/definitions/ReportTermsUserTrackingTcData","description":"The Terms &amp; Conditions data"},"user_data":{"$ref":"#/definitions/ReportTermsUserTrackingUserData","description":"The user data"}}},"ReportTermsUserTrackingTcData":{"required":["tc_id","tc_name","tc_acceptance_message","tc_body","tc_answer"],"properties":{"tc_id":{"type":"integer","description":"The Terms &amp; Conditions record ID"},"tc_name":{"$ref":"#/definitions/ReportTermsUserTrackingTcName","description":"The name of the terms and conditions record in all languages"},"tc_acceptance_message":{"$ref":"#/definitions/ReportTermsUserTrackingTcAcceptanceMessage","description":"The acceptance message of the terms and conditions record in all languages"},"tc_body":{"$ref":"#/definitions/ReportTermsUserTrackingTcBody","description":"The body of the terms and conditions record in all languages"},"tc_answer":{"type":"string","description":"Indicates if the terms and conditions are accepted"}}},"ReportTermsUserTrackingTcName":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation"}}},"ReportTermsUserTrackingTcAcceptanceMessage":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation"}}},"ReportTermsUserTrackingTcBody":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation"}}},"ReportTermsUserTrackingUserData":{"required":["user_data","additional_fields","saml_settings"],"properties":{"user_data":{"$ref":"#/definitions/ReportTermsUserTrackingUserDataL2","description":""},"additional_fields":{"type":"array","description":"","items":{"$ref":"#/definitions/ReportTermsUserTrackingAdditionalFields"}},"saml_settings":{"$ref":"#/definitions/ReportTermsUserTrackingSamlSettings","description":""}}},"ReportTermsUserTrackingUserDataL2":{"required":["user_id","username","first_name","last_name","email","uuid","lang_code","lang_browsercode","is_saml_provision","language","manager_id","cant_have_direct_manager","avatar","force_change","expiration","level","date_format","timezone","email_validation_status","valid","manager_first_name","manager_last_name","manager_username","can_manage_subordinates"],"properties":{"user_id":{"type":"integer","description":"The user ID or username of the user"},"username":{"type":"string","description":"The username of the user"},"first_name":{"type":"string","description":"The first name of the user"},"last_name":{"type":"string","description":"The last name of the user"},"email":{"type":"string","description":"The email address of the user"},"uuid":{"type":"string","description":"The UUID (universally unique identifier) of the user"},"lang_code":{"type":"string","description":"User UI language code"},"lang_browsercode":{"type":"string","description":"User UI language browser code"},"is_saml_provision":{"type":"string","description":"Is SAML provision"},"language":{"type":"string","description":"User UI language. This field is deprecated and it will be dropped on 2018-07-31"},"manager_id":{"type":"string","description":"Manager id. It is available only for NOT pending users"},"cant_have_direct_manager":{"type":"boolean","description":"The user can&#039;t have a direct manager"},"avatar":{"type":"string","description":"The avatar of the user"},"force_change":{"type":"string","description":"Indicates if the user is forced to change their password"},"expiration":{"type":"string","format":"date","description":"The expiration date of a user. This is available only for NOT pending users."},"level":{"type":"integer","description":"The level of a user. This is available only for NOT pending users."},"date_format":{"type":"string","description":"The date format, example values are: &#039;ar&#039;, &#039;ar_dz&#039;, &#039;bg&#039;, &#039;en&#039;, &#039;en-gb&#039;, &#039;it&#039;, &#039;es&#039;"},"timezone":{"type":"string","description":"The timezone, for example: &#039;Europe/Madrid&#039;"},"email_validation_status":{"type":"integer","description":"The email validation status of an user. This is available only for NOT pending users"},"valid":{"type":"integer","description":"Indicates if the user is active. Possible options are 0 for not active or 1 for active."},"manager_first_name":{"type":"string","description":"The manager first name. This is available only for NOT pending users."},"manager_last_name":{"type":"string","description":"The manager last name. It is available only for NOT pending users."},"manager_username":{"type":"string","description":"The manager username. It is available only for NOT pending users."},"can_manage_subordinates":{"type":"boolean","description":"Indicates if the user can manage subordinates. It is available only for NOT pending users."}}},"ReportTermsUserTrackingAdditionalFields":{"required":["id","title","mandatory","invisible_to_user","value"],"properties":{"id":{"type":"integer","description":"The field ID"},"title":{"type":"string","description":"The field title"},"mandatory":{"type":"integer","description":"Indicates if the field is mandatory. Possible values are: 0 for false or 1 for true."},"invisible_to_user":{"type":"integer","description":"Indicates if the field is invisible to regular users. Possible values are: 0 for false or 1 for true."},"value":{"type":"string","description":"Chosen value by user"},"download_url":{"type":"string","description":"The URL of the downloadable file. This item is only available for UPLOAD fields."},"options":{"$ref":"#/definitions/ReportTermsUserTrackingOptions","description":"The dropdown options if field type is set to &#039;dropdown&#039; or &#039;country&#039;"}}},"ReportTermsUserTrackingOptions":{"required":["id","label"],"properties":{"id":{"type":"integer","description":"The option ID"},"label":{"type":"string","description":"The option title"}}},"ReportTermsUserTrackingSamlSettings":{"required":["unique_field","lock_provisioned_user_fields","provisioned_user_fields","multidomain"],"properties":{"unique_field":{"type":"string","description":"Unique field"},"lock_provisioned_user_fields":{"type":"integer","description":"Indicates if provisioned user fields are locked. Possible values are: 0 for false or 1 for true. If this value is 1 then provisioned field are read only."},"provisioned_user_fields":{"type":"array","description":"Users provisioning fields from SAML Settings, the &#039;key&#039; in array is a Field name, the &#039;value&#039; is Attribute statement","items":{"$ref":"#/definitions/ReportTermsUserTrackingProvisionedUserFields"}},"multidomain":{"type":"array","description":"For a user it returns the first multidomain found in the path to the associated branch (or branches).","items":{"$ref":"#/definitions/ReportTermsUserTrackingMultidomain"}}}},"ReportTermsUserTrackingProvisionedUserFields":{},"ReportTermsUserTrackingMultidomain":{},"ReportUserreportStartUsersReportSchema":{"type":"object","required":["user_ids"],"properties":{"user_ids":{"type":"array","description":"The user IDs to include in the report","items":{"type":"integer"}},"interactions":{"type":"boolean","description":"A TRUE/FALSE parameter indicating whether or not to also return the user&#039;s interactions"}}},"ReportUserreportStartUsersReportResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ReportUserreportStartUsersReportData","description":"Response data"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ReportUserreportStartUsersReportLinks"}}}},"ReportUserreportStartUsersReportData":{"required":["job_id"],"properties":{"job_id":{"type":"string","description":"The unique Job ID to check status later"}}},"ReportUserreportStartUsersReportLinks":{},"ReportUserreportUsersReportStatusResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ReportUserreportUsersReportStatusData","description":"Response data"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ReportUserreportUsersReportStatusLinks"}}}},"ReportUserreportUsersReportStatusData":{"required":["status"],"properties":{"status":{"type":"string","description":"The current status, possible values are &quot;running&quot; or &quot;completed&quot;"},"data":{"type":"array","description":"Only returned when status is &quot;completed&quot;.","items":{"$ref":"#/definitions/ReportUserreportUsersReportStatusDataL2"}},"failed_users":{"type":"array","description":"Only returned when the status is &quot;completed&quot;.","items":{"$ref":"#/definitions/ReportUserreportUsersReportStatusFailedUsers"}}}},"ReportUserreportUsersReportStatusDataL2":{"required":["userid","total_questions","total_correct","percent_correct"],"properties":{"userid":{"type":"integer","description":"The ID of the user being processed"},"total_questions":{"type":"integer","description":"The number of total interactions by this user"},"total_correct":{"type":"integer","description":"The number of correct interactions by this user"},"percent_correct":{"type":"number","format":"float","description":"A weighted percentage between the total interactions and the correct interactions by this user"},"courses":{"type":"array","description":"Details for each of the courses this user is enrolled in (that contains a SCORM)","items":{"$ref":"#/definitions/ReportUserreportUsersReportStatusCourses"}}}},"ReportUserreportUsersReportStatusCourses":{"required":["course_id","total_questions","total_correct","percent_correct","course_name","courseuser_status","course_progress"],"properties":{"course_id":{"type":"integer","description":"The course ID"},"total_questions":{"type":"integer","description":"The number of total interactions in this course for this user"},"total_correct":{"type":"integer","description":"The number of correct interactions in this course for this user"},"percent_correct":{"type":"integer","description":"A weighted percentage between the total and correct interactiosn by this user in this course"},"course_name":{"type":"string","description":"The course name"},"courseuser_status":{"type":"string","description":"The enrollment status"},"date_complete":{"type":"string","format":"date","description":"The course completion date in format yyyy-MM-dd HH:mm:ss (in UTC timezone)"},"course_progress":{"type":"number","format":"double","description":"The percentage of training materials completed by this user"},"interactions":{"type":"array","description":"A list of interactions by this user in this course","items":{"$ref":"#/definitions/ReportUserreportUsersReportStatusInteractions"}}}},"ReportUserreportUsersReportStatusInteractions":{"required":["id"],"properties":{"id":{"type":"string","description":"The interaction name"},"learner_response":{"type":"string","description":"Either an array of interaction responses or a string with the response of the user"}}},"ReportUserreportUsersReportStatusFailedUsers":{"required":["userid","error"],"properties":{"userid":{"type":"integer","description":"The ID of the user requested to process"},"error":{"type":"string","description":"The reason this user failed to process, for example: user doesn&#039;t exist"}}},"ReportUserreportUsersReportStatusLinks":{}}}