API Explorer 896 endpoints

Get audit_report List

GET /obp/dynamic-entity/audit_report

OBPv4.0.0-dynamicEntity_getaudit_reportList_ Roles: CanGetDynamicEntityRecord_audit_report(per bank) _Audit_reportDynamic-EntityDynamic

Get audit_report List.

Parsed entity audit_report. This Dynamic Entity is part of OGCR.

Property List:

  • audit_report_summary: Short human-readable summary of audit scope, approach, and conclusion.
  • operator_id: Operator’s legal name
  • activity_id: Internal identifier for the activity entity
  • certification_scope: Scope of certification
  • certification_scheme_id: Methodology(ies) the scheme applies (identifier + version).
  • certification_methodology_legal_reference: Legal reference for certification methodology
  • activity_plan_id: Reference number of the activity plan
  • monitoring_plan_id: Reference number of the monitoring plan
  • permanent_net_carbon_removal_benefit: Expected/verified amount of permanent net carbon removal benefit (in Co2e Tonnes)
  • temporary_net_carbon_removal_benefit: Expected/verified amount of temporary net carbon removal benefit (in Co2e Tonnes)
  • net_soil_emission_reduction_benefit: Expected/verified amount of net soil emission reduction benefit (in Co2e Tonnes)
  • sustainability_co_benefits: Sustainability co-benefits associated with the activity
  • certification_body_id: Legal or trading name of the certification body
  • national_accreditation_body: National accreditation body and scope/date of accreditation (or recognition authority and scope/date)
  • accreditation_scope: Accreditation scope
  • accreditation_date: Accreditation date
  • national_recognition_authority: National recognition authority
  • recognition_scope: Recognition scope
  • recognition_date: Recognition date
  • audit_date: Date of the audit
  • audit_itinerary: Audit itinerary and duration (split onsite/remote where relevant)
  • audit_duration_onsite: Duration spent on-site
  • audit_duration_remote: Duration spent remotely
  • sites_audited: Sites audited
  • audit_method_risk_assessment: Audit method, risk assessment
  • other_certification_schemes_or_standards_certified: Certification of other certification schemes or standards
  • ghg_data_type: GHG data type
  • audit_report_issue_location: Place of issuance of the audit report
  • audit_report_issue_date: Date of issuance of the audit report
  • certificate_valid_from_date: Certificate valid from date
  • certificate_valid_to_date: Certificate valid to date
  • date_certified: Date certified (if applicable)
  • non_conformities_list: List of non-conformities identified
  • non_conformities_remediation_timeline: Timeline for remediation of non-conformities
  • issuing_party_signature_or_stamp: Stamp and/or signature of issuing party

MethodRouting settings example:

<details>

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"audit_report"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

</details>

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Filtering, sorting and pagination on the list endpoint:

(no fields on this entity are declared indexed, so only the legacy bare-parameter filter below is available.)

  • Filter: ?obp_filter[FIELD]=OP:VALUE. Operators: eq, ne, in, lt, gt, le, ge, between, like, is_null, not_set. in / between take comma-separated values; is_null / not_set take no value. Repeat the same key to AND several constraints on one field. e.g. ?obp_filter[status]=eq:active&obp_filter[amount]=between:10,100 or ?obp_filter[closed_date]=not_set
  • Legacy filter (still supported): bare field parameters, e.g. ?name=James%20Brown&number=123.456&number=11.11 filters by name == "James Brown" && (number == 123.456 || number == 11.11).
  • Sort: ?obp_sort_by=FIELD[,FIELD2]&obp_sort_direction=ASC|DESC.
  • Paginate: ?obp_limit=20&obp_offset=40.

Filtering, sorting, pagination and is_null / not_set work on every deployment (no special backend required).

One-hop joins (EXISTS / NOT EXISTS) — filter this entity by a condition on a related entity linked through a declared reference: field:

  • ?obp_exists[RelatedEntity] — keep rows that have at least one related RelatedEntity.
  • ?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE — ...that have at least one matching the predicate.
  • ?obp_not_exists[RelatedEntity] — keep rows with NO related RelatedEntity at all.
  • ?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE — ...with no related RelatedEntity matching the predicate (this includes rows that have no related RelatedEntity).
  • If two entities are linked by more than one reference, disambiguate the edge with via:, e.g. ?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed.

The nested filter[...] reuses the operator grammar above. Mind the distinction: obp_not_exists[X]=filter[flag]=eq:true (no related X with flag=true — includes rows with no X) is not the same as obp_exists[X]=filter[flag]=ne:true (has a related X with flag≠true — excludes rows with no X).

Only a field typed reference:<Entity> and declared indexed: true forms a join edge; a plain string field holding ids is not joinable.

Joins require the SQL projection backend (dynamic_entity.indexing.backend=auto on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns 400 (OBP-09022); while an index is still building it returns 409. The plain filter / sort / paginate / is_null / not_set features above do not need the projection backend.

Example success response
{
  "audit_report_list": [
    {
      "audit_report_id": "d8839721-ad8f-45dd-9f78-2080414b93f9",
      "audit_report_summary": "Audit confirmed conformance to methodology X for monitoring period FY2027; no major non-conformities.",
      "operator_id": "op_05OFWI037022",
      "activity_id": "a_05OFWI037022",
      "certification_scope": "TBD",
      "certification_scheme_id": "{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}",
      "certification_methodology_legal_reference": "TBD",
      "activity_plan_id": "ap_01HZY3...",
      "monitoring_plan_id": "mp_01HZYW...",
      "permanent_net_carbon_removal_benefit": 6,
      "temporary_net_carbon_removal_benefit": 6,
      "net_soil_emission_reduction_benefit": 6,
      "sustainability_co_benefits": "TBD",
      "certification_body_id": "DNV Business Assurance Germany GmbH",
      "national_accreditation_body": "TBD",
      "accreditation_scope": "TBD",
      "accreditation_date": "TBD",
      "national_recognition_authority": "TBD",
      "recognition_scope": "TBD",
      "recognition_date": "2026-05-24",
      "audit_date": "2026-12-15",
      "audit_itinerary": "TBD",
      "audit_duration_onsite": "TBD",
      "audit_duration_remote": "TBD",
      "sites_audited": "TBD",
      "audit_method_risk_assessment": "TBD",
      "other_certification_schemes_or_standards_certified": "TBD",
      "ghg_data_type": "TBD",
      "audit_report_issue_location": "TBD",
      "audit_report_issue_date": "2026-12-20",
      "certificate_valid_from_date": "2027-01-01",
      "certificate_valid_to_date": "2031-12-31",
      "date_certified": "2026-12-25",
      "non_conformities_list": "TBD",
      "non_conformities_remediation_timeline": "TBD",
      "issuing_party_signature_or_stamp": "TBD"
    }
  ]
}
Possible errors (3)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented by OBPv4.0.0 dynamicEntity_getaudit_reportList_ Originally /audit_report