Inspectorio Responsible Sourcing & Compliance API
Responsible Sourcing & Compliance (Rise) integration API — assessments, reports, organizations, and metadata.
OpenAPI Specification
{ "openapi": "3.0.3", "info": { "title": "RSC API", "version": "v1" }, "servers": [ { "description": "Production Environment", "url": "https://rise-integration.inspectorio.com" }, { "description": "Pre-Production Environment", "url": "https://rise-integration.pre.inspectorio.com" } ], "security": [ { "ApiKeyAuth": [] } ], "paths": { "/api/v1/auth/login": { "post": { "deprecated": true, "operationId": "login", "description": "Login and Retrieve Access Token", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Login" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestApiError" } } }, "description": "Bad request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthenticatedApiError" } } }, "description": "Unauthorized" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateApiError" } } }, "description": "Validation Error" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalApiError" } } }, "description": "Internal Error" } }, "security": [], "summary": "Login and Retrieve Access Token", "tags": [ "AUTH" ] } }, "/api/v1/metadata/{namespace}": { "post": { "operationId": "createMetadata", "description": "Create Metadata", "parameters": [ { "description": "The logical type of data that is set by Inspectorio", "in": "path", "name": "namespace", "required": true, "schema": { "enum": [ "questionnaire", "higg" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Metadata" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateMetadataResponse" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestApiError" } } }, "description": "Bad request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthenticatedApiError" } } }, "description": "Unauthorized" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateApiError" } } }, "description": "Validation Error" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalApiError" } } }, "description": "Internal Error" } }, "summary": "Create Metadata", "tags": [ "METADATA" ] } }, "/api/v1/metadata/{namespace}/{uid}": { "delete": { "operationId": "deleteMetadata", "description": "Delete Metadata", "parameters": [ { "description": "The logical type of data that is set by Inspectorio", "in": "path", "name": "namespace", "required": true, "schema": { "enum": [ "questionnaire", "higg" ], "type": "string" } }, { "description": "UIDs (unique identifiers) are unique within Ecosystem + Namespace. You can consider it as a Unique Keys of ecosystem + namespace + uid", "in": "path", "name": "uid", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": {} } }, "description": "No Content" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestApiError" } } }, "description": "Bad request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthenticatedApiError" } } }, "description": "Unauthorized" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateApiError" } } }, "description": "Validation Error" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalApiError" } } }, "description": "Internal Error" } }, "summary": "Delete Metadata", "tags": [ "METADATA" ] }, "get": { "operationId": "getMetadata", "description": "Get Metadata", "parameters": [ { "description": "The logical type of data that is set by Inspectorio", "in": "path", "name": "namespace", "required": true, "schema": { "enum": [ "questionnaire", "higg" ], "type": "string" } }, { "description": "UIDs (unique identifiers) are unique within Ecosystem + Namespace. You can consider it as a Unique Keys of ecosystem + namespace + uid", "in": "path", "name": "uid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMetadataResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestApiError" } } }, "description": "Bad request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthenticatedApiError" } } }, "description": "Unauthorized" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateApiError" } } }, "description": "Validation Error" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalApiError" } } }, "description": "Internal Error" } }, "summary": "Get Metadata", "tags": [ "METADATA" ] }, "put": { "operationId": "updateMetadata", "description": "Update Metadata", "parameters": [ { "description": "The logical type of data that is set by Inspectorio", "in": "path", "name": "namespace", "required": true, "schema": { "enum": [ "questionnaire", "higg" ], "type": "string" } }, { "description": "UIDs (unique identifiers) are unique within Ecosystem + Namespace. You can consider it as a Unique Keys of ecosystem + namespace + uid", "in": "path", "name": "uid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataUpdate" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateMetadataResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestApiError" } } }, "description": "Bad request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthenticatedApiError" } } }, "description": "Unauthorized" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateApiError" } } }, "description": "Validation Error" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalApiError" } } }, "description": "Internal Error" } }, "summary": "Update Metadata", "tags": [ "METADATA" ] } }, "/api/v1/organizations": { "post": { "operationId": "createOrganization", "description": "Create Organization", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationCreate" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDetailResponse" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestApiError" } } }, "description": "Bad request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthenticatedApiError" } } }, "description": "Unauthorized" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateApiError" } } }, "description": "Validation Error" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalApiError" } } }, "description": "Internal Error" } }, "summary": "Create Organization", "tags": [ "ORGANIZATION" ] } }, "/api/v1/organizations/{organization_id}": { "get": { "operationId": "getOrganization", "description": "Get Organization", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDetailResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestApiError" } } }, "description": "Bad request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthenticatedApiError" } } }, "description": "Unauthorized" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateApiError" } } }, "description": "Validation Error" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalApiError" } } }, "description": "Internal Error" } }, "summary": "Get Organization", "tags": [ "ORGANIZATION" ] }, "put": { "operationId": "updateOrganization", "description": "Update Organization", "parameters": [ { "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationUpdate" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDetailResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestApiError" } } }, "description": "Bad request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthenticatedApiError" } } }, "description": "Unauthorized" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateApiError" } } }, "description": "Validation Error" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalApiError" } } }, "description": "Internal Error" } }, "summary": "Update Organization", "tags": [ "ORGANIZATION" ] } }, "/api/v1/reports": { "get": { "operationId": "listReports", "description": "List Reports", "parameters": [ { "description": "Type of the assessment between \"Self Assessment\" or \"Verification Assessment\"", "in": "query", "name": "assessment_type", "required": false, "schema": { "enum": [ "Self Assessment", "Verification Assessment" ], "example": "Self Assessment", "type": "string" } }, { "description": "Status of the reports", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "New", "Verification Requested", "Declined", "Case Completed", "Assessment Canceled" ], "example": "New", "type": "string" } }, { "description": "Earliest date of the report date range", "in": "query", "name": "report_generate_date_from", "required": false, "schema": { "example": "2020-01-01", "format": "date", "type": "string" } }, { "description": "From the date reports are updated", "in": "query", "name": "updated_date_from", "required": false, "schema": { "example": "2020-01-01", "format": "date", "type": "string" } }, { "description": "Limit result of list", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "maximum": 10, "minimum": 1, "type": "integer" } }, { "description": "To the date reports are updated", "in": "query", "name": "updated_date_to", "required": false, "schema": { "example": "2020-01-02", "format": "date", "type": "string" } }, { "description": "Latest date of the report date range", "in": "query", "name": "report_generate_date_to", "required": false, "schema": { "example": "2020-01-02", "format": "date", "type": "string" } }, { "description": "Order used to sort the reports whether ascending or descending", "in": "query", "name": "order", "required": false, "schema": { "default": "report_generate_date:desc", "example": "report_generate_date:desc", "type": "string" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportListResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestApiError" } } }, "description": "Bad request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthenticatedApiError" } } }, "description": "Unauthorized" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateApiError" } } }, "description": "Validation Error" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalApiError" } } }, "description": "Internal Error" } }, "summary": "List reports", "tags": [ "REPORT" ] } }, "/api/v1/reports/{report_id}": { "get": { "description": "Get Report", "operationId": "getReport", "parameters": [ { "in": "path", "name": "report_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportDetailResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestApiError" } } }, "description": "Bad request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthenticatedApiError" } } }, "description": "Unauthorized" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateApiError" } } }, "description": "Validation Error" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalApiError" } } }, "description": "Internal Error" } }, "summary": "Get Report", "tags": [ "REPORT" ] } }, "/api/v2/reports": { "get": { "operationId": "listReportsV2", "description": "List Reports V2 with additional data about report and CAPA", "parameters": [ { "description": "Type of the assessment between \"Self Assessment\" or \"Verification Assessment\"", "in": "query", "name": "assessment_type", "required": false, "schema": { "enum": [ "Self Assessment", "Verification Assessment" ], "example": "Self Assessment", "type": "string" } }, { "description": "Status of the reports", "in": "query", "name": "report_status", "required": false, "schema": { "enum": [ "New", "Verification Requested", "Declined", "Case Completed", "Assessment Canceled" ], "example": "New", "type": "string" } }, { "description": "Requestee ID", "in": "query", "name": "requestee_id", "required": false, "schema": { "example": "F_123", "type": "string" } }, { "description": "Status of the CAPA", "in": "query", "name": "capa_status", "required": false, "schema": { "enum": [ "New", "In-Progress", "Assessment Requested", "Submitted", "In Review", "Declined", "Closed", "Assessment Canceled", "Reopened", "Approved" ], "example": "New", "type": "string" } }, { "description": "Earliest date of the report date range", "in": "query", "name": "report_generate_date_from", "required": false, "schema": { "example": "2020-01-01", "format": "date", "type": "string" } }, { "description": "From the date reports are updated", "in": "query", "name": "updated_date_from", "required": false, "schema": { "example": "2020-01-01", "format": "date", "type": "string" } }, { "description": "Limit result of list", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "To the date reports are updated", "in": "query", "name": "updated_date_to", "required": false, "schema": { "example": "2020-01-02", "format": "date", "type": "string" } }, { "description": "Latest date of the report date range", "in": "query", "name": "report_generate_date_to", "required": false, "schema": { "example": "2020-01-02", "format": "date", "type": "string" } }, { "description": "Order used to sort the reports whether ascending or descending", "in": "query", "name": "order", "required": false, "schema": { "default": "report_generate_date:desc", "example": "report_generate_date:desc", "type": "string" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2ReportListResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestApiError" } } }, "description": "Bad request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthenticatedApiError" } } }, "description": "Unauthorized" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateApiError" } } }, "description": "Validation Error" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalApiError" } } }, "description": "Internal Error" } }, "summary": "List reports", "tags": [ "REPORT-V2" ] } }, "/api/v2/reports/{report_id}": { "get": { "description": "Get Report V2 with additional data about report and CAPA", "operationId": "getReportV2", "parameters": [ { "in": "path", "name": "report_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "capa_details", "required": false, "schema": { "type": "boolean" }, "description": "Get additional information about CAPA" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2ReportDetailResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestApiError" } } }, "description": "Bad request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthenticatedApiError" } } }, "description": "Unauthorized" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateApiError" } } }, "description": "Validation Error" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalApiError" } } }, "description": "Internal Error" } }, "summary": "Get Report", "tags": [ "REPORT-V2" ] } }, "/api/v1/assessments/search": { "post": { "operationId": "searchAssessmentsV1", "description": "Search Assessments V1 with filters and pagination", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1AssessmentSearchRequest" } } } }, "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1AssessmentListResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestApiError" } } }, "description": "Bad request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthenticatedApiError" } } }, "description": "Unauthorized" }, "422":
# --- truncated at 32 KB (248 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/inspectorio/refs/heads/main/openapi/inspectorio-rsc-openapi.json