uri fragment
/members/{member}/groups/{group}/uris/{uri}/fragments/{+fragment} [PUT]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.0100 | 6.0000 | xml |
Description
Fragment's Content.
Create new edit on fragment provided.
The new content of the fragment must be in the enclosed entity body of the request.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| content | New fragment content. DEPRECATED, use enclosed entity body of the request | maybe | string | |
| draft | A flag to save edit as a draft | no | boolean | false |
| html | A flag to specify if content is HTML | no | boolean | false |
| labels | The label values for the edit | no | labels | |
| lastmodified | The last modified date/time (ISO-8601) of the fragment (prevents edit clashes) | no | date | |
| note | Content for edit notes (if exists, creates a note) | no | string | |
| note-labels | Comma-separated list of label values for the note (if exists, creates a note) | no | labels | false |
| note-title | Title for edit note | no | string | Edit Note |
| position | The position (instance number) of this document in the publication (requires publicationid) | no | integer | 1 |
| publicationid | The ID of the publication context for this document to return numbering (requires transclude=true) | no | publicationid | |
| transclude | A flag to resolve transclusions when outputting result | no | boolean | false |
Permission
This service requires contributor or higher.
Response
When successful, the new fragment is returned as a <document-fragment> wrapped in a <fragment-creation> element with the following optional attributes:
unresolved-xrefs="true"– if their are unresolved cross references in the fragment.
Example:
<fragment-creation [unresolved-xrefs="true"]>
<document-fragment [draft="true"]>
<locator id="325"
fragment="example"
editid="6340"
modified="2015-03-24T13:21:57">
<notes>
<note id="6342"
modified="2015-03-24T13:21:57"
title="Typography">
<content>Fixed typographical error.</content>
</note>
</notes>
</locator>
<fragment id="example">
<para>This is the fragment content</para>
</fragment>
</document-fragment>
</fragment-creation>
Error Handling
| Code | Cause / Description |
|---|---|
| 0x120B | Error processing XRefs |
| 0x120C | Error creating fragment |
| 0x120D | Content validation error |
| 0x120E | lastmodified date is invalid |
| 0x120F | Someone has modified the fragment while you were editing |
| 0x122D | The fragment is invalid |