CHchloris

Retrieve one or more reporting unit entries.

post/reportingUnit

Request

Request body

organizationIdstring

organization ID

reportingUnitIdstring

reporting unit UUID, omit to list all reporting units

limitinteger

The maximum number of reporting units to list

nextTokenstring

Token used for list pagination. Omit to start at the beginning.

branchesboolean

Whether to list reporting unit aggregation branches

historicalboolean

Whether to list previous versions of reporting units. May be used with reportingUnitId to list historical versions for a specific reporting unit.

draftsboolean

Whether to list draft versions of reporting units. May be used with reportingUnitId to list drafts for a specific reporting unit.

filterReportingUnitIdsstring[]

Filter the list of reporting units to only include these reportingUnitIDs. May not be used with historical or drafts.

Example request

{
  "organizationId": "12341234-1234-1234-1234-123412341234",
  "reportingUnitId": "12341234-1234-1234-1234-123412341234",
  "limit": 100,
  "nextToken": "12341234-1234-1234-1234-123412341234",
  "branches": true,
  "historical": true,
  "drafts": true,
  "filterReportingUnitIds": [
    "12341234-1234-1234-1234-123412341234",
    "12341234-1234-1234-1234-123412341234"
  ]
}

Response

Success

OR

Example response

{
  "reportingUnits": [
    {
      "organizationId": "12341234-1234-1234-1234-123412341234",
      "reportingUnitId": "12341234-1234-1234-1234-123412341234",
      "branchId": "12341234-1234-1234-1234-123412341234",
      "controlReportingUnitId": "12341234-1234-1234-1234-123412341234",
      "controlForReportingUnitId": "12341234-1234-1234-1234-123412341234",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "analysisSubmittedAt": "2024-01-01T00:00:00.000Z",
      "analysisCompletedAt": "2024-01-01T00:00:00.000Z",
      "qualityControlledAt": "2024-01-01T00:00:00.000Z",
      "deletedAt": "2024-01-01T00:00:00.000Z",
      "refundedAt": "2024-01-01T00:00:00.000Z",
      "usersNotifiedAt": "2024-01-01T00:00:00.000Z",
      "webhookNotifiedAt": "2024-01-01T00:00:00.000Z",
      "periodChangeStartYear": 2020,
      "periodChangeEndYear": 2023,
      "boundaryPath": "s3://path/to/boundary",
      "calibratedTo": "12341234-1234-1234-1234-123412341234",
      "calibratedFrom": "12341234-1234-1234-1234-123412341234",
      "mangrove": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.