Connectors Reference

iAuditor

Fast and easy mobile inspection reporting. Get real-time visibility to uncover insights and raise standards.

 

Status: Preview

Tier: Premium

Version: 1.0.0

 

Actions:

Name

Summary

SearchAudits ([Optional]string order, [Optional]string modified_after, [Optional]string modified_before, [Optional]string template, [Optional]string archived, [Optional]string completed, [Optional]string owner, [Optional]integer limit)

Search modified audits

GetAuditById (string auditId)

Get a specific audit

CreateAuditLink (string auditId)

Generate a link to an audit

InitiateAuditExport (string auditId, string format, [Optional]string timezone, [Optional]string export_profile)

Export an audit report

PollExportStatus (string auditId, string exportId)

Check the status of the export request submitted earlier

GetAuditExport (string auditId, string exportId, string filename)

Download an audit report

GetWebReportLink (string auditId)

Retrieve an audit web report link

DeleteWebReportLink (string auditId)

Delete an audit web report link

SearchExportProfiles ()

Get a list of available export profiles

SearchTemplates ([Optional]string order, [Optional]string modified_after, [Optional]string modified_before, [Optional]string archived, [Optional]string owner, [Optional]integer limit)

Search modified templates

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

AuditSearchResponse

 

ExportStatusResponse

 

GetAuditByIdResponse

 

GetAuditLinkResponse

 

InitExportResponse

 

SearchExportProfilesResponse

 

TemplateSearchResponse

 

 

Actions:

SearchAudits

Summary: Search modified audits

Description: Retrieve the list of audits between certain dates, and search by other constraints including the source template and whether it is archived.

 

Syntax:

iAuditor.SearchAudits ([Optional]string order, [Optional]string modified_after, [Optional]string modified_before, [Optional]string template, [Optional]string archived, [Optional]string completed, [Optional]string owner, [Optional]integer limit)

 

Parameters:

Name

Type

Summary

Required

Related Action

order

string

(Sort Order)Values: [desc, asc]

The datetime order in which the audits will be given.

False

modified_after

string(date-time)

(Modified After)

Audits should be last modified after this date and time.

False

modified_before

string(date-time)

(Modified Before)

Audits should be last modified before this date and time.

False

template

string

(Filter by Template)

Audits should be made from this template.

False

SearchTemplates

archived

string

(Archived)Values: [true, false, both]

Flag indicating should audits be archived, non archived, or both.

False

completed

string

(Completed)Values: [true, false, both]

Flag indicating should audits be completed, non completed, or both.

False

owner

string

(Ownership)Values: [me, other, all]

Retrieve audits owned by me or shared with me by other users. Or all the audits I have access to.

False

limit

integer

(Limit (Max 1000))

Maximum number of entries to return.

False

 

Returns:

          Type:AuditSearchResponse

 

GetAuditById

Summary: Get a specific audit

Description: Retrieve the full data contained in a single audit.

 

Syntax:

iAuditor.GetAuditById (string auditId)

 

Parameters:

Name

Type

Summary

Required

Related Action

auditId

string

(Audit ID)

The unique identifier of a specific audit.

True

 

Returns:

          Type:GetAuditByIdResponse

 

CreateAuditLink

Summary: Generate a link to an audit

Description: Generate a link to a specific audit that opens in iAuditor/SafetyCulture.

 

Syntax:

iAuditor.CreateAuditLink (string auditId)

 

Parameters:

Name

Type

Summary

Required

Related Action

auditId

string

(Audit ID)

The unique identifier of a specific audit.

True

 

Returns:

          Type:GetAuditLinkResponse

 

InitiateAuditExport

Summary: Export an audit report

Description: Submit an export request for an audit into the format passed as a query parameter.

 

Syntax:

iAuditor.InitiateAuditExport (string auditId, string format, [Optional]string timezone, [Optional]string export_profile)

 

Parameters:

Name

Type

Summary

Required

Related Action

auditId

string

(Audit ID)

The unique identifier of a specific audit.

True

format

string

(Format)Values: [pdf, docx]

The format for the export.

True

timezone

string

(Timezone)Values: [Pacific/Auckland, Australia/Brisbane, Asia/Tokyo, Asia/Shanghai, Asia/Karachi, Europe/Moscow, Europe/Brussels, Europe/London, America/St_Johns, America/Argentina/Buenos_Aires, America/New_York, America/Mexico_City, America/Guatemala, Etc/UTC]

The timezone for the export.

False

export_profile

string

(Export Profile)

The id of the export profile to be applied.

False

SearchExportProfiles

 

Returns:

          Type:InitExportResponse

 

PollExportStatus

Summary: Check the status of the export request submitted earlier

Description: Check whether the download report submitted earlier is ready for download.

 

Syntax:

iAuditor.PollExportStatus (string auditId, string exportId)

 

Parameters:

Name

Type

Summary

Required

Related Action

auditId

string

(Audit ID)

The unique identifier of a specific audit.

True

exportId

string

(Export Task ID)

The ID that references the export request.

True

 

Returns:

          Type:ExportStatusResponse

 

GetAuditExport

Summary: Download an audit report

Description: Download the audit report submitted earlier.

 

Syntax:

iAuditor.GetAuditExport (string auditId, string exportId, string filename)

 

Parameters:

Name

Type

Summary

Required

Related Action

auditId

string

(Audit ID)

The unique identifier of a specific audit.

True

exportId

string

(Export Task ID)

The ID that references the export request.

True

filename

string

(Audit Report Filename)

The filename generated by the export request.

True

 

Returns:

          Type:string(binary)

          Summary: Audit Report

          Description: Audit Report as either PDF or Docx file.

 

GetWebReportLink

Summary: Retrieve an audit web report link

Description: If a link has previously been generated for this audit it is returned otherwise a new link is generated.

 

Syntax:

iAuditor.GetWebReportLink (string auditId)

 

Parameters:

Name

Type

Summary

Required

Related Action

auditId

string

(Audit ID)

The unique identifier of a specific audit.

True

 

Returns:

          Type:GetAuditLinkResponse

 

DeleteWebReportLink

Summary: Delete an audit web report link

Description: Delete the link to the web report of the audit.

 

Syntax:

iAuditor.DeleteWebReportLink (string auditId)

 

Parameters:

Name

Type

Summary

Required

Related Action

auditId

string

(Audit ID)

The unique identifier of a specific audit.

True

 

Returns:

 

SearchExportProfiles

Summary: Get a list of available export profiles

Description: Profile ids can be used in export requests to ally the specified export profile.

 

Syntax:

iAuditor.SearchExportProfiles ()

 

Returns:

          Type:SearchExportProfilesResponse

 

SearchTemplates

Summary: Search modified templates

Description: Retrieve the list of templates between certain dates and by other constraints.

 

Syntax:

iAuditor.SearchTemplates ([Optional]string order, [Optional]string modified_after, [Optional]string modified_before, [Optional]string archived, [Optional]string owner, [Optional]integer limit)

 

Parameters:

Name

Type

Summary

Required

Related Action

order

string

(Sort Order)Values: [desc, asc]

The datetime order in which the templates will be given.

False

modified_after

string(date-time)

(Modified After)

Templates should be last modified after this date and time.

False

modified_before

string(date-time)

(Modified Before)

Templates should be last modified before this date and time.

False

archived

string

(Archived)Values: [true, false, both]

Flag indicating should templates be archived, non archived, or both.

False

owner

string

(Ownership)Values: [me, other, all]

Retrieve templates owned by me or shared with me by other users. Or all the templates I have access to.

False

limit

integer

(Limit (Max 1000))

Maximum number of entries to return.

False

 

Returns:

          Type:TemplateSearchResponse

 


 

AuditSearchResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

count

number

Count

The number of matching audits that have been returned in the search run.

total

number

Total

The total number of matching audits for the search.

audits

array of (AuditsItem)

Audits

 

 

AuditsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

audit_id

string

Audit ID

Unique identifier of the audit.

modified_at

string(date-time)

Date Modified

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

template_id

string

Template ID

Unique identifier of the template.

 


 

ExportStatusResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

status

string

Export Status

The current status of the requested export.

href

string

Export URL

The web URL to the completed audit export file.

filename

string

Filename

The filename of the exported audit report.


 

GetAuditByIdResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

template_id

string

Template ID

Unique identifier of the template.

audit_id

string

Audit ID

Unique identifier of the audit.

audit_data

Audit_data

 

 

template_data

Template_data

 

 

 

Audit_data

Summary:

Description:

 

          Properties:

Name

Type

Summary

score

number

Score

Score corresponding to the audit.

total_score

number

Total Score

Current total score.

score_percentage

number(float)

Score Percentage

Percent portion of the total score.

name

string

Audit Title

Name or title of the audit.

duration

number

Duration (s)

Duration of the audit in seconds.

authorship

Authorship

 

 

date_completed

string(date-time)

Date Completed

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

date_modified

string(date-time)

Date Modified

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

date_started

string(date-time)

Date Started

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

 

Authorship

Summary:

Description:

 

          Properties:

Name

Type

Summary

owner

string

Audit Owner

The user who originally created the audit.

owner_id

string

Audit Owner ID

The user ID of the audit owner.

author

string

Audit Author

The user who last edited the audit.

author_id

string

Audit Author ID

The user ID of the audit author.

 

Template_data

Summary:

Description:

 

          Properties:

Name

Type

Summary

authorship

Authorship

 

 

metadata

Metadata

 

 

 

Authorship

Summary:

Description:

 

          Properties:

Name

Type

Summary

owner

string

Template Owner

The user who originally created the template.

owner_id

string

Template Owner ID

The user ID of the template owner.

author

string

Template Author

The user who last edited the template.

author_id

string

Template Author ID

The user ID of the template author.

 

Metadata

Summary:

Description:

 

          Properties:

Name

Type

Summary

description

string

Template Description

Information about the template.

name

string

Template Name

Title of the template.

 


 

GetAuditLinkResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

url

string

Audit Link

The audit link which will open in SafetyCulture or iAuditor.


 

InitExportResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Export Task ID

Unique identifier of the export task.


 

SearchExportProfilesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

export_profiles

array of (Export_profilesItem)

 

 

 

Export_profilesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Export Profile ID

The unique identifier of the Export Profile.

name

string

Export Profile Name

The name of the Export Profile.

 


 

TemplateSearchResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

count

number

Count

Count of the current template.

total

number

Total

Total nnumber of templates.

templates

array of (TemplatesItem)

Templates

 

 

TemplatesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

template_id

string

Template ID

Unique identifier of the template.

name

string

Template Name

Title of the template.