Skip to main content
Version: v1

RSC API

Integration API for Inspectorio Rise/Sight (RSC). Lets external systems manage organizations (factories and partners), attach custom metadata to entities, and read assessment/audit results.

Key concepts:

  • Organization: a factory or partner entity identified by an externally-assigned id (e.g. F123). Organizations of type partner can be linked to factory organizations via partners.

  • Metadata: arbitrary typed key/value data attached to an entity, scoped by namespace (questionnaire or higg) and a uid that identifies the target entity within that namespace. Use this to sync data owned by an external system into Inspectorio without a purpose-built endpoint.

  • Reports / Assessments: results of a completed or in-progress audit or self-assessment. Two parallel object models exist:

    • v1 (/api/v1/reports, /api/v1/assessments): the original, richer model. getAssessment with include_step_questions=true is the canonical single-call export of a full questionnaire (sections, questions, answers).
    • v2 (/api/v2/reports): a newer, lightweight section/category summary with CAPA (Corrective and Preventive Action) data, but without questionnaire question/answer detail. Use v2 for report-level status and CAPA tracking; use v1 getAssessment when question/answer-level data is needed.
    • getStepExecution returns a single step's full questionnaire content (sections, questions, answers) and is shared by both the v1 and v2 report models.

  • SMETA: listOrganizationSmetaReports returns SEDEX-sourced SMETA audit reports for an organization; it requires the organization to have an active SEDEX integration configured in Inspectorio.

Authentication: every request requires an apiKey header (see the ApiKeyAuth security scheme). Tokens are organization/account-scoped; an organization can only access its own data.

Authentication​

Security Scheme Type:

apiKey

Header parameter name:

apiKey