V1AssessmentSearchRequest

case_idinteger

Filter by case ID (numeric custom ID)

Example: 100000

assessment_typestring

Type of the assessment

Possible values: [Self Assessment, Verification Assessment]

Example: Self Assessment

assessment_status object

Filter by assessment status (single value or comma-separated string) - accepts New, In Progress, Completed, Submitted, Aborted, Assessment Canceled, Report Declined

oneOf

string

string

Possible values: [New, In Progress, Completed, Submitted, Aborted, Assessment Canceled, Report Declined]

string

string

Possible values: Value must match regular expression ^(New|In Progress|Completed|Submitted|Aborted|Assessment Canceled|Report Declined)(,(New|In Progress|Completed|Submitted|Aborted|Assessment Canceled|Report Declined))*$

workflowstring

Filter by workflow name

Example: Draft

workflow_namestring

Filter by workflow name (alternative parameter name)

Example: Draft

standard_namestring

Filter by standard name (single value or comma-separated string)

Example: Environmental Audit - RS Std

standard_versionstring

Filter by standard version (single value or comma-separated string)

Example: 6.1

rating_labelsstring

Filter by rating label names (single value or comma-separated string)

Example: Excellent

scheduling_statusstring

Filter by scheduling status

Possible values: [N/A, Waiting for Scheduling, Scheduled, Completed, Confirmed, Declined]

Example: Waiting for Scheduling

assessed_org_idstring

Filter by assessed organization external ID

Example: F123

requester_org_idstring

Filter by requester organization external ID (single value or comma-separated string)

Example: R123

executor_org_idstring

Filter by executor organization external ID (single value or comma-separated string)

Example: E123

selected_partner_org_idstring

Filter by selected partner organization (UUID, external ID, or organization name - single value or comma-separated). Supports 'null' to filter assessments with no selected partners.

Example: 123e4567-e89b-12d3-a456-426614174000,partner123,Factory Org Name

countrystring

Filter by country/region code (single value or comma-separated - US, CN, VN, etc.)

Example: US,CN,VN

reasonstring

Filter by reason name (single value or comma-separated)

Example: Regular Audit,Special Audit

capa_statusstring

Status of the CAPA

Possible values: [New, In-Progress, Assessment Requested, Submitted, In Review, Declined, Closed, Assessment Canceled, Reopened, Approved]

Example: New

capa_due_date_fromstring<date>

Earliest date of the CAPA due date range

Example: 2020-01-01

capa_due_date_tostring<date>

Latest date of the CAPA due date range

Example: 2020-01-02

due_date_fromstring<date>

Earliest date of the due date range

Example: 2020-01-01

due_date_tostring<date>

Latest date of the due date range

Example: 2020-01-02

assessment_due_date_fromstring<date>

Earliest date of the assessment due date range (alternative to due_date_from)

Example: 2020-01-01

assessment_due_date_tostring<date>

Latest date of the assessment due date range (alternative to due_date_to)

Example: 2020-01-02

audit_date_fromstring<date>

Earliest date of the audit date range (filters assessments with audit dates from this date onwards)

Example: 2020-01-01

audit_date_tostring<date>

Latest date of the audit date range (filters assessments with audit dates up to this date)

Example: 2020-01-02

audit_start_date_fromstring<date>

Earliest date of the audit start date range - filters assessments by their audit start date

Example: 2020-01-01

audit_start_date_tostring<date>

Latest date of the audit start date range - filters assessments by their audit start date

Example: 2020-01-02

audit_end_date_fromstring<date>

Earliest date of the audit end date range - filters assessments by their audit end date

Example: 2020-01-01

audit_end_date_tostring<date>

Latest date of the audit end date range - filters assessments by their audit end date

Example: 2020-01-02

assessment_submit_date_fromstring<date>

Earliest date of the assessment submission date range

Example: 2020-01-01

assessment_submit_date_tostring<date>

Latest date of the assessment submission date range

Example: 2020-01-02

updated_date_fromstring<date>

From the date assessments are updated

Example: 2020-01-01

updated_date_tostring<date>

To the date assessments are updated

Example: 2020-01-02

updated_datetime_fromstring<date-time>

From the datetime assessments are updated (ISO 8601 format with Zulu timezone)

Example: 2020-01-01T12:34:56Z

updated_datetime_tostring<date-time>

To the datetime assessments are updated (ISO 8601 format with Zulu timezone)

Example: 2020-01-01T12:34:56Z

orderstring

Order used to sort the assessments whether ascending or descending. Allowed fields - updated_date, created_date, due_date, status, assessment_type, assessmentId, assessmentSubmitDate, assessmentDueDate, auditStartDate, auditEndDate, updatedDate, rating, score. Format - {field}:asc or {field}:desc

Possible values: Value must match regular expression ^(updated_date|created_date|due_date|status|assessment_type|assessmentId|assessmentSubmitDate|assessmentDueDate|auditStartDate|auditEndDate|updatedDate|rating|score)(:(asc|desc))?$

Default value: updated_date:desc

Example: assessmentId:asc

searchstring

Search term for filtering assessments

Example: factory

limitinteger

Limit result of list

Possible values: >= 1 and <= 1000

Default value: 20

offsetinteger

Offset for pagination

Possible values: >= 0

Default value: 0

V1AssessmentSearchRequest

{
  "case_id": 100000,
  "assessment_type": "Self Assessment",
  "assessment_status": "New",
  "workflow": "Draft",
  "workflow_name": "Draft",
  "standard_name": "Environmental Audit - RS Std",
  "standard_version": "6.1",
  "rating_labels": "Excellent",
  "scheduling_status": "Waiting for Scheduling",
  "assessed_org_id": "F123",
  "requester_org_id": "R123",
  "executor_org_id": "E123",
  "selected_partner_org_id": "123e4567-e89b-12d3-a456-426614174000,partner123,Factory Org Name",
  "country": "US,CN,VN",
  "reason": "Regular Audit,Special Audit",
  "capa_status": "New",
  "capa_due_date_from": "2020-01-01",
  "capa_due_date_to": "2020-01-02",
  "due_date_from": "2020-01-01",
  "due_date_to": "2020-01-02",
  "assessment_due_date_from": "2020-01-01",
  "assessment_due_date_to": "2020-01-02",
  "audit_date_from": "2020-01-01",
  "audit_date_to": "2020-01-02",
  "audit_start_date_from": "2020-01-01",
  "audit_start_date_to": "2020-01-02",
  "audit_end_date_from": "2020-01-01",
  "audit_end_date_to": "2020-01-02",
  "assessment_submit_date_from": "2020-01-01",
  "assessment_submit_date_to": "2020-01-02",
  "updated_date_from": "2020-01-01",
  "updated_date_to": "2020-01-02",
  "updated_datetime_from": "2020-01-01T12:34:56Z",
  "updated_datetime_to": "2020-01-01T12:34:56Z",
  "order": "assessmentId:asc",
  "search": "factory",
  "limit": 20,
  "offset": 0
}