Skip to main content

List reports

GET 
/api/v1/reports

List Reports

Request​

Query Parameters

    assessment_type string

    Possible values: [Self Assessment, Verification Assessment]

    Type of the assessment between "Self Assessment" or "Verification Assessment"

    status string

    Possible values: [New, Verification Requested, Declined, Case Completed, Assessment Canceled]

    Status of the reports

    report_generate_date_from date

    Earliest date of the report date range

    updated_date_from date

    From the date reports are updated

    limit integer

    Possible values: >= 1 and <= 10

    Default value: 10

    Limit result of list

    updated_date_to date

    To the date reports are updated

    report_generate_date_to date

    Latest date of the report date range

    order string

    Default value: report_generate_date:desc

    Order used to sort the reports whether ascending or descending

    offset integer

    Default value: 0

Responses​

OK

Schema

    data

    object[]

    nullable

    Report data

  • Array [

    • assessment

    object

    assessmentDueDate date-timenullable

    Due date of assessment

    assessmentId stringnullable

    Unique identifier

    id stringnullable

    Unique technical identifier

    type stringnullable

    Type, e.g. 'Self-Assessment', 'Verification Assessment'

    businessAreas string[]nullable

    The business areas involved in the report

    capa

    object

    id stringnullable

    Unique identifier

    name stringnullable

    Name

    case

    object

    history

    object

    History of the case

    comment stringnullable

    Comment of the update

    reasons string[]nullable

    Reasons set by user for the case history update

    updatedDate date-timenullable

    Updated data of the case

    updatedValidityDuration stringnullable

    Validity Duration set by user or calculated using Expiration Date

    id stringnullable

    Unique technical identifier

    uid stringnullable

    Unique identifier

    completeCaseDate date-timenullable

    Completed date of the case

    country stringnullable

    The country code of the organization being evaluated or audited, in standard ISO 3166-1 Alpha-2 code, e.g. CN for China

    createdDate date-timenullable

    Creation date of the report

    departmentNumbers string[]nullable

    The list of department numbers involved in the report

    escalations

    object[]

    nullable

    List of escalations of the assessment

  • Array [

    • createdDate date-timenullable

    Date when the Escalation was created

    escalatedBy

    object

    Information of the user

    email stringnullable

    Email address of the user

    firstName stringnullable

    First name of the user

    id stringnullable

    Unique identifier of the user

    lastName stringnullable

    Last name of the user

    escalatedTo

    object[]

    nullable

    The user who receives the escalation

  • Array [

    • email stringnullable

    Email address of the user

    firstName stringnullable

    First name of the user

    id stringnullable

    Unique identifier of the user

    lastName stringnullable

    Last name of the user

  • ]

    • escalationNote stringnullable

    Escalation note

    resolvedByUser

    object

    Information of the user

    email stringnullable

    Email address of the user

    firstName stringnullable

    First name of the user

    id stringnullable

    Unique identifier of the user

    lastName stringnullable

    Last name of the user

    resolvedDate date-timenullable

    Resolution date of the escalation

    status stringnullable

    Status of the escalation

  • ]

    • exception stringnullable

    Rating exception”

    executionLocations string[]nullable

    The locations of the execution, e.g. 'Desktop Review', 'Factory Visit', 'Scheme Onsite', 'Target Onsite'

    executor

    object

    name stringnullable

    Name

    uid stringnullable

    Unique identifier

    expirationDate date-timenullable

    Expiration date set by the user or calculated using Validity Duration

    id string

    Unique technical identifier of the report

    labels

    object[]

    Labels

  • Array [

    • label stringnullable

    Type of label assigned in the assignment/report/CAPA

    value stringnullable

    Label assigned in the assignment/report/CAPA

  • ]

    • office stringnullable

    The name of the office being evaluated or audited

    productLines string[]nullable

    The list of product lines involved in the report

    province stringnullable

    The province of the organization being evaluated or audited

    rating stringnullable

    Rating, e.g. 'Acceptable for Production', 'Acceptable', 'Auto-Fail', 'Critical', 'Factory at Risk', 'Failed Out of Tolerance', 'Needs Improvement', 'Non Compliant', 'Not Acceptable', 'Not Acceptable/Invalid', 'Outstanding', 'Unknown', 'Zero Tolerance'

    reason

    object

    id stringnullable

    Unique identifier

    name stringnullable

    Name

    reopenCaseDate date-timenullable

    The date the case was reopen

    reportDeclineDate date-timenullable

    Declined date of the report

    reportGenerateDate date-timenullable

    Generation date of the report

    reportName stringnullable

    Name of the report

    requestee

    object

    email stringnullable

    Contact email of the organization who submitted the assessment

    name stringnullable

    Name

    uid stringnullable

    Unique identifier

    requester

    object

    name stringnullable

    Name

    uid stringnullable

    Unique identifier

    score stringnullable

    Score of the report

    scoreInPercentage stringnullable

    Score in percentage of the report

    standard

    object

    id stringnullable

    Unique identifier

    name stringnullable

    Name

    version stringnullable

    Standard Version

    status stringnullable

    The status of the report

    totalAvailableCapacityInUnits integernullable

    The total available capacity in units

    type stringnullable

    Type of report, e.g. 'internal', 'external'

    updatedDate date-timenullable

    Updated date of the report

    workflow

    object

    id stringnullable

    Unique identifier

    name stringnullable

    Name

  • ]

    • limit integer

    Possible values: >= 1 and <= 10

    Default value: 10

    Limit result of list

    offset integer

    Default value: 0

    Number of items are skipped

    total integerrequired
Loading...