UK Data AtlasAPI

List relationship candidates

A behind-the-scenes report of relationships between areas found in the raw boundary files, and whether each has been published as a crosswalk yet.

get
/relationship-candidates

Returns

RelationshipCandidateListEnvelope

The discovered relationship candidates.

  • apiVersionv1required
  • atlasReleasestringrequired

    The immutable /atlas-release releaseId for the artifacts that produced this response.

  • metaobjectrequired
    Show1 child field
    • nextCursorstring | nullrequired

      Opaque cursor for the next page, or null at the end.

  • dataRelationshipCandidate[]required
    Show7 child fields
    • idstringrequired
    • inputstringrequired
    • fromRelationshipCandidateSiderequired
      Show4 child fields
      • geographystringrequired
      • boundaryReleasestringrequired
      • codePropertystringrequired
      • namePropertystringrequired
    • toRelationshipCandidateTargetrequired

      boundaryRelease (and sometimes geography) are present only when exactly one compiled area release already uses this code/name property pair.

      Show4 child fields
      • geographystringoptional
      • boundaryReleasestringoptional
      • codePropertystringrequired
      • namePropertystringrequired
    • statusenumrequired
      One ofeligibleneeds-reviewnot-available
    • publishedCrosswalkIdstringoptional

      Set when a published crosswalk already covers this candidate.

    • validationobjectrequired
      Show3 child fields
      • endpointsobjectrequired
        Show2 child fields
        • fromRelationshipCandidateEndpointStatusrequired
        • toRelationshipCandidateEndpointStatusrequired
      • relationshipobjectrequired
        Show5 child fields
        • sourceFeatureCountintegerrequired
        • sourceCodeCountintegerrequired
        • targetCodeCountintegerrequired
        • multiTargetSourceCountintegerrequired
        • missingValueFeatureCountintegerrequired
      • reasonsstring[]required

When it goes wrong

  • 503The referenced build artifact has not been built yet.

Every error has the same shape. See Errors for how to handle them.

Technical notes

Show the precise behaviour

Scans every compiled area release's raw source for extra code/name property pairs beyond the one already used for its own identity, and reports whether a matching compiled target release exists. A candidate already covered by a published crosswalk carries that crosswalk's id in publishedCrosswalkId. This is a discovery and gap report, not an instruction to auto-publish every eligible candidate as a crosswalk without review — see the status values below.