Dela via


iAuditor (Preview)

iAuditor is the world's most popular inspection checklist app. SafetyCulture is iAuditor's cloud based backup and management system. Manage all your inspection teams and analyse data collected from the field. iAuditor and SafetyCulture give you real-time visibility across your entire operation.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name iAuditor Support
URL https://www.safetyculture.com/contact-us
Email support@safetyculture.com
Connector Metadata
Publisher SafetyCulture Pty Ltd
Website https://safetyculture.com/
Privacy policy https://safetyculture.com/legal/privacy-policy/
Categories Data;Productivity

The iAuditor Connector provides an API to work with iAuditor inspection data.

Prerequisites

To use this connector, you will need to have the following:

How to get credentials

Known issues and limitations

  • Actions to export responses from multiple choice questions with multiple selection enabled are not supported.
  • Actions to export responses within Repeat sections are not supported.

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API token securestring Input format: 'Bearer True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Check inspection export status

Check the inspection export status.

Check the status of the export request submitted earlier (legacy)

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

Create an action

Create a new action

Delete an action

Delete an existing action

Disable an inspection web report link

Disable the web report link to an inspection.

Download an audit report (legacy)

Download the audit report submitted earlier.

Export an audit report (legacy)

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

Export an inspection report

Submit an export request for an inspection report in the selected format.

Generate a link to an inspection [DEPRECATED]

Generate a link to a specific inspection that opens in iAuditor/SafetyCulture.

Get a specific inspection

Retrieve the full data of an inspection.

Get an inspection media

Get a media file from an inspection

Retrieve an inspection web report link

If a link has previously been generated for this inspection, it is returned. Otherwise a new link is generated.

Search actions

Find actions related based upon their status, priority, assignees, item, inspection and more.

Search modified inspections

Retrieve the list of inspections filtered by dates, template, completion status and more.

Set the archived state of an inspection

Choose 'Yes' to archive the inspection and 'No' to restore the archived inspection.

Update an action

Update an existing action

Check inspection export status

Check the inspection export status.

Parameters

Name Key Required Type Description
Audit ID
auditId True string

The unique identifier of a specific inspection.

Export Task ID
exportId True string

The unique identifierof an export task.

Returns

Check the status of the export request submitted earlier (legacy)

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

Parameters

Name Key Required Type Description
Audit ID
auditId True string

The unique identifier of a specific inspection.

Export Task ID
exportId True string

The unique identifierof an export task.

Returns

Create an action

Create a new action

Parameters

Name Key Required Type Description
Audit ID
audit_id string

The unique identifer of the inspection.

Item ID
item_id string

The unique identifier of the question/item.

Title
title string

The text to use for the action title.

Description
description string

The text to use for the action description.

Priority
priority string

The priority to assign for the action: 0=None, 10=Low, 20=Medium, 30=High.

Status
status string

The status to set for the action: 0=To Do, 10=In Progress, 50=Done, 60=Can't Do.

Due At
due_at date-time

The due date and time to set for the action.

Assignee ID
id string

The assignee's user ID or email (external).

Type
type string

The type of assignee. Either 'user' or 'email (external)'.

Returns

Body
action

Delete an action

Delete an existing action

Parameters

Name Key Required Type Description
Action ID
actionId True string

The unique identifier of a specific action.

Returns

Name Path Type Description
ok
ok boolean

ok

Disable the web report link to an inspection.

Parameters

Name Key Required Type Description
Audit ID
auditId True string

The unique identifier of a specific inspection.

Download an audit report (legacy)

Download the audit report submitted earlier.

Parameters

Name Key Required Type Description
Audit ID
auditId True string

The unique identifier of a specific inspection.

Export Task ID
exportId True string

The unique identifierof an export task.

Inspection Report Filename
filename True string

The filename generated by an export request.

Returns

Audit Report as either PDF or Docx file.

Audit Report
binary

Export an audit report (legacy)

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

Parameters

Name Key Required Type Description
Audit ID
auditId True string

The unique identifier of a specific inspection.

Format
format True string

The format to generate an export in.

Timezone
timezone string

The timezone to use when generating an export.

Export Profile
export_profile string

The unique identifier of the export profile to generate an export with.

Returns

Export an inspection report

Submit an export request for an inspection report in the selected format.

Parameters

Name Key Required Type Description
Audit ID
auditId True string

The unique identifier of a specific inspection.

Export Format
format string

The format to export an inspection report to.

Preference ID
preference_id string

The Report Preference to apply to the report export.

Returns

Generate a link to a specific inspection that opens in iAuditor/SafetyCulture.

Parameters

Name Key Required Type Description
Audit ID
auditId True string

The unique identifier of a specific inspection.

Returns

Get a specific inspection

Retrieve the full data of an inspection.

Parameters

Name Key Required Type Description
Audit ID
auditId True string

The unique identifier of a specific inspection.

Returns

Get an inspection media

Get a media file from an inspection

Parameters

Name Key Required Type Description
Audit ID
auditId True string

The unique identifier of a specific inspection.

media ID
mediaId True string

The unique identifier of a specific media file.

Returns

The media file from an inspection

Media File
binary

If a link has previously been generated for this inspection, it is returned. Otherwise a new link is generated.

Parameters

Name Key Required Type Description
Audit ID
auditId True string

The unique identifier of a specific inspection.

Returns

Search actions

Find actions related based upon their status, priority, assignees, item, inspection and more.

Parameters

Name Key Required Type Description
Audit ID(s)
audit_id array of string

One or more audit IDs to search for actions within.

Assignee ID
id string

The assignee's user ID or email (external).

Type
type string

The type of assignee. Either 'user' or 'email (external)'.

After Date
from date-time

Search for results created after this date and time.

Before Date
to date-time

Search for results created before this date and time.

After Date
from date-time

Search for results modified after this date and time.

Before Date
to date-time

Search for results modified before this date and time.

After Date
from date-time

Search for results due after this date and time.

Before Date
to date-time

Search for results due before this date and time.

Returns

Search modified inspections

Retrieve the list of inspections filtered by dates, template, completion status and more.

Parameters

Name Key Required Type Description
Sort Order
order string

The date and time order in which the results will be given.

Modified After
modified_after date-time

Filter to include results last modified after this date and time.

Modified Before
modified_before date-time

Filter to include results last modified before this date and time.

Filter by Template
template string

Filter to include results from a specific template.

Archived
archived string

Filter to include only archived (true), non-archived (false), or both.

Completed
completed string

Filter results to include only complete, incomplete, or both.

Ownership
owner string

Retrieve results owned by me, shared with me by other users, or all that I have access to.

Limit (Max 1000)
limit integer

Maximum number of results to return. Shorten your recurrence and get past time intervals to retrieve more results

Returns

Set the archived state of an inspection

Choose 'Yes' to archive the inspection and 'No' to restore the archived inspection.

Parameters

Name Key Required Type Description
Audit ID
auditId True string

The unique identifier of a specific inspection.

Archived
archived boolean

Yes/No

Returns

Update an action

Update an existing action

Parameters

Name Key Required Type Description
Action ID
actionId True string

The unique identifier of a specific action.

Title
title string

The text to use for the action title.

Description
description string

The text to use for the action description.

Priority
priority string

The priority to assign for the action: 0=None, 10=Low, 20=Medium, 30=High.

Status
status string

The status to set for the action: 0=To Do, 10=In Progress, 50=Done, 60=Can't Do.

Due At
due_at date-time

The due date and time to set for the action.

Assignee ID
id string

The assignee's user ID or email (external).

Type
type string

The type of assignee. Either 'user' or 'email (external)'.

Returns

Body
action

Definitions

action_id

The unique identifier of the action.

The unique identifier of the action.

Action ID
string

count

The number of actions returned.

The number of actions returned.

Count
number

total

The total number of actions found in the search parameters.

The total number of actions found in the search parameters.

Total
number

offset

The offset/page of the current set of results.

The offset/page of the current set of results.

Offset
number

AuditSearchResponse

Name Path Type Description
Count
count count

The number of actions returned.

Total
total total

The total number of actions found in the search parameters.

Inspection
audits array of object
Audit ID
audits.audit_id string

The unique identifier of the inspection.

Date Modified
audits.modified_at date-time

The date and time the inspection was last modified, in the format of: yyyy-MM-ddTHH:mm:ss.fffZ (UTC time).

Template ID
audits.template_id string

The unique identifier of the template.

GetAuditLinkResponse

Name Path Type Description
Inspection Link
url string

The inspection report link which can be viewed from a web browser.

InitExportResponse

Name Path Type Description
Export Task ID
id string

The unique identifier of the export task.

InitInspectionExportResponse

Name Path Type Description
Export Task ID
messageId string

The unique identifier of the export task.

ExportStatusResponse

Name Path Type Description
Export Status
status string

The current status of the export request.

Export URL
href string

The web URL to the exported inspection report file.

Filename
filename string

The filename of the exported inspection report.

InspectionExportStatusResponse

Name Path Type Description
Export URL
url string

The web URL to the exported inspection report file.

Export status
status string

The current status of the export request.

GetAuditByIdResponse

Name Path Type Description
Template ID
template_id string

The unique identifier of the template.

Audit ID
audit_id string

The unique identifier of the inspection.

Score
audit_data.score number

The score achieved in the inspection.

Total Score
audit_data.total_score number

The total score of the inspection.

Score Percentage
audit_data.score_percentage float

The score of the inspection in percentage.

Inspection Title
audit_data.name string

The name/title of the inspection.

Duration
audit_data.duration number

The duration of the inspection in seconds.

Inspection Owner
audit_data.authorship.owner string

The user who owns the inspection.

Inspection Owner ID
audit_data.authorship.owner_id string

The user ID of the inspection owner.

Inspection Author
audit_data.authorship.author string

The user who created the inspection.

Inspection Author ID
audit_data.authorship.author_id string

The user ID of the inspection author.

Date Completed
audit_data.date_completed date-time

The date and time the inspection was completed, in the format of: yyyy-MM-ddTHH:mm:ss.fffZ (UTC time).

Date Modified
audit_data.date_modified date-time

The date and time the inspection was last modified, in the format of: yyyy-MM-ddTHH:mm:ss.ffZ (UTC time).

Date Started
audit_data.date_started date-time

The date and time the inspection was started, in the format of: yyyy-MM-ddTHH:mm:ss.fffZ (UTC time).

Template Owner
template_data.authorship.owner string

The user who owns the template.

Template Owner ID
template_data.authorship.owner_id string

The user ID of the template owner.

Template Author
template_data.authorship.author string

The user who created the template.

Template Author ID
template_data.authorship.author_id string

The user ID of the template author.

Template Description
template_data.metadata.description string

The description of the template.

Template Name
template_data.metadata.name string

The name of the template.

ActionsSearchResponse

Name Path Type Description
Count
count count

The number of actions returned.

Total
total total

The total number of actions found in the search parameters.

Offset
offset offset

The offset/page of the current set of results.

Actions
actions array of action

Actions

action

Name Path Type Description
Action ID
action_id action_id

The unique identifier of the action.

Audit ID
audit.audit_id string

The unique identifier of the inspection.

Inspection Title
audit.name string

The name/title of the inspection.

Item ID
item.item_id string

The question/item's unique identifier.

Item Label
item.label string

The question/item's label.

Description
description string

The description of the action.

Title
title string

The title of the action.

Site
site string

The selected site of the action.

Priority
priority integer

The priority of the action: 0=None, 10=Low, 20=Medium, 30=High.

Status
status integer

The status of the action: 0=To Do, 10=In Progress, 50=Done, 60=Can't Do.

Assignees
assignees array of object

The assignees of the action.

Assignee ID
assignees.id string

The assignee's user ID or email (external).

Assignee Name
assignees.name string

The action assignee's name or email (external).

Type
assignees.type string

The type of assignee. Either 'user' or 'email (external)'.

Creator ID
created_by.user_id string

The unique identifier of the user who created the action.

Creator Name
created_by.name string

The name of the user who created the action.

Creation Date
created_at date-time

The date and time the action was created.

Modification Date
modified_at date-time

The date and time the action was last modified.

Due Date
due_at date-time

The date and time the action was due.

Completion Date
completed_at date-time

The date and time the action was completed.

binary

This is the basic data type 'binary'.