org-coverage-targets

Update a workspace coverage target

Changed on

Update a coverage target and notify watched workspaces of status changes.

Use this coverage-target operation to track places, issues, actor types, and source gaps that a workspace intends to improve. Link evidence and review state before treating a target as complete.

patch/api/orgs/{org_id}/coverage-targets/{target_id}

Request

  • Base URL: https://atlas.rebuildingus.org
  • URL: https://atlas.rebuildingus.org/api/orgs/{org_id}/coverage-targets/{target_id}
  • Auth: none declared

Path parameters

org_idstring required
target_idstring required

Headers

x-api-keystring nullable

Request body

actor_typesstring[] nullable

actor types for this coverage target.

geographystring nullable

geography for this coverage target.

issue_areasstring[] nullable

issue areas for this coverage target.

last_reviewed_atstring nullable

last reviewed at for this coverage target.

linked_discovery_run_idsstring[] nullable

linked discovery run ids for this coverage target.

linked_entry_idsstring[] nullable

linked entry ids for this coverage target.

namestring nullable

name for this coverage target.

next_actionsstring[] nullable

next actions for this coverage target.

review_state'needs_research' | 'in_review' | 'ready_for_delivery' nullable

review state for this coverage target.

source_typesstring[] nullable

source types for this coverage target.

Response

Successful Response

actor_typesstring[] required

actor types for this coverage target.

created_atstring required

created at for this coverage target.

created_bystring required

created by for this coverage target.

geographystring required

geography for this coverage target.

idstring required

id for this coverage target.

issue_areasstring[] required

issue areas for this coverage target.

last_reviewed_atstring nullable required

last reviewed at for this coverage target.

last_run_atstring nullable required

last run at for this coverage target.

linked_discovery_run_idsstring[] required

linked discovery run ids for this coverage target.

linked_entry_idsstring[] required

linked entry ids for this coverage target.

namestring required

name for this coverage target.

next_actionsstring[] required

next actions for this coverage target.

org_idstring required

org id for this coverage target.

records_foundinteger required

records found for this coverage target.

review_state'needs_research' | 'in_review' | 'ready_for_delivery' required

review state for this coverage target.

source_typesstring[] required

source types for this coverage target.

sources_reviewedinteger required

sources reviewed for this coverage target.

status'covered' | 'thin' | 'unknown' | 'stale' | 'blocked' required

status for this coverage target.

status_reasonstring required

status reason for this coverage target.

updated_atstring required

updated at for this coverage target.

Changes

  • 6ea72ce93d40Revision changes
    • warning

      deleted the header request parameter x-atlas-actor-email

    • warning

      deleted the header request parameter x-atlas-actor-id

    • warning

      deleted the header request parameter x-atlas-internal-secret

    • warning

      deleted the header request parameter x-atlas-organization-id