Compare a local edit with the incoming version
The local body and the retained incoming one, side by side.
/v1/help-centre/articles/{translation_id}/conflictViewer- Operation id
- get_conflict
- Access
- Any workspace role can call this.
/v1/help-centre/articles/{translation_id}/conflictThe local body and the retained incoming one, side by side.
Call this when an article has has_conflict set: someone edited it here,
and then an update arrived from the source. Neither version has been lost
and neither has been applied.
local_body_html is what is live now. incoming_body_html is what the
source sent, and incoming_sanitize_report says what the sanitiser stripped
out of it, which is worth reading before adopting.
An article with no conflict is refused rather than answered with two identical bodies.
The incoming version is served sanitised, never as the stored bytes. See
staff_write.conflict_comparison for why that is not negotiable.
Tenancy: the request is scoped to one workspace, and the credential presented is what selects it. A caller with no membership in that workspace is refused with 404, which is indistinguishable from a workspace that does not exist.
Authorisation: any workspace role, including viewer. Reads are open to every member.
Access: Authorization: Bearer carrying either a realm access token or an API key. A key must hold the help-centre-staff:read scope, and the workspace role of the person who owns it must meet the floor above.
A realm-issued access token, presented as Authorization: Bearer <token>. It acts as the person who signed in, and every operation resolves their workspace role live from the membership record.
In: header
Path Parameters
uuidQuery Parameters
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/help-centre/articles/497f6eca-6276-4993-bfeb-53cbbbba6f08/conflict"{ "translation_id": "string", "locale": "string", "title": "string", "body_format": "string", "conflict_seen_at": "2019-08-24T14:15:22Z", "locally_edited_at": "2019-08-24T14:15:22Z", "local_body_html": "string", "incoming_body_html": "string", "incoming_sanitize_report": {}}