Revision
Method: post revision list
Authorization is required.
Request
HTTP request
GET https://<YOUR_DOMAIN>/api/v1/en_US/revision/post/list/{groupId}?offset={offset}&pageSize={pageSize}
Parameters
| property | value | description |
|---|---|---|
| groupId | guid | The elements group's ID |
| offset | integer | Needed for the infinite scroll functionality. It is the ID of the last presented item to the user. After the request list is generated the system will skip all records from the beginning up to the record with the provided ID (including it). The next batch of records will be returned in the response. |
| pageSize | integer | How many records to be returned by the system. Usually 15 |
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response JSON with the following structure:
{
"success": true,
"message": "Minim magna laborum proident laboris ipsum adipisicing nostrud duis.",
"timestamp": "2014-03-03T23:20:23Z",
"errors": [],
"object": {
"offset": "d9459b6a-6e8d-4409-9dad-ded54add9583",
"revisions": [
{
"id": 1,
"type": "postRevision",
"group": {
"id": "d9459b6a-6e8d-4409-9dad-ded54add9583",
"name": "pariatur",
"slug": "Home",
"thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
"url": "http://demo.hivesocialnow.com/Home/"
},
"createdOn": "2014-03-03T23:20:23Z",
"author": {
"id": "1911ae14-271b-4994-a666-40225d6d47f2",
"alias": "duis labore",
"extendedAlias": "irure proident duis sit est",
"slug": "Home",
"avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
"url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
},
"title": "Aliquip eu esse sint veniam velit qui fugiat do non sint do.",
"summary": "Veniam eiusmod ex commodo commodo anim commodo aliqua excepteur adipisicing consequat consequat officia laborum minim.",
"content": "Incididunt reprehenderit in occaecat ipsum culpa occaecat proident culpa qui ullamco. ",
"post": {
"id": "bd48579a-097c-4e18-8e16-a363599691fa",
"title": "Est elit id sit anim eu excepteur velit id proident laborum dolor.",
"summary": "Esse quis velit culpa dolor dolore ut reprehenderit in incididunt exercitation aute aliqua magna veniam.",
"content": "Sit incididunt ut sunt ad deserunt. Enim est ut mollit cillum est mollit id Lorem incididunt consequat irure laboris fugiat consequat. ",
"slug": "Home",
"url": "/Home/posts/123"
},
"accessWarnings": []
}
]
}
}
The general response properties are described on the Response format page. Here are the list of the specific properties for this method.
| property | value | description |
|---|---|---|
| id | integer | The id of the post revision. Unique for all revisions not only for one post. |
| group | object | In which group this revision was created |
| createdOn | date | When the revision was created in ISO 8601 string format and UTC time zone |
| author | object | Some common properties of the user that created the revision: id, name, slug, thumbUrl, url (of the group home page) |
| title | string | The title of the revision |
| summary | string | The summary of the revision revision |
| content | string | The content of the revision revision |
| post | object | The parent element of the revision with some common properties in their current state. |
Method: restore post revision
Authorization is required. This method will update the parent post and will exchange its contents with the revision ones.
Request
HTTP request
POST https://<YOUR_DOMAIN>/api/v1/en_US/revision/post/{revisionId}/rollback
Parameters
Request bodyDo not supply a request body with this method.ResponseIf successful, this method returns a response JSON with the following structure: { "timestamp": "2014-03-03T23:20:23Z", "success": true, "message": "Aliqua anim consequat amet cupidatat proident amet amet.", "errors": [], "object": { "id": 1, "type": "postRevision", "group": { "id": "ecf4ee77-7440-4505-b544-9b443c20092b", "name": "aute", "slug": "Home", "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png", "url": "http://demo.hivesocialnow.com/Home/" }, "createdOn": "2014-03-03T23:20:23Z", "author": { "id": "240f8e1a-310e-42ab-a8f4-6bf7ca9d35c8", "alias": "non eu", "extendedAlias": "culpa aliquip Lorem in nisi", "slug": "Home", "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg", "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/" }, "title": "Nisi adipisicing sit ex ut aliqua dolore cupidatat officia Lorem excepteur culpa quis.", "summary": "Voluptate cillum do in nisi est deserunt incididunt eu culpa. ", "content": "Ex velit incididunt excepteur consectetur adipisicing sint", "post": { "id": "df37813c-0467-452e-8781-ef3e11e007aa", "title": "Elit ex aliquip non occaecat sunt fugiat ut eiusmod minim minim incididunt exercitation.", "summary": "Deserunt adipisicing culpa incididunt cillum proident ", "content": "Proident mollit minim ut laboris consectetur sint id pariatur excepteur irure excepteur do enim. ", "slug": "Home", "url": "/Home/posts/123" }, "accessWarnings": [] } } The general response properties are described on the Response format page. Here are the list of the specific properties for this method.Method: comment revision listAuthorization is required.RequestHTTP requestGET https://<YOUR_DOMAIN>/api/v1/en_US/revision/comment/list/{groupId}?offset={offset}&pageSize={pageSize}ParametersRequest bodyDo not supply a request body with this method.ResponseIf successful, this method returns a response JSON with the following structure: { "success": true, "message": "Anim labore voluptate sint elit occaecat cillum mollit aliqua labore veniam.", "timestamp": "2014-03-03T23:20:23Z", "errors": [], "object": { "offset": 869, "revisions": [ { "id": 1, "type": "commentRevision", "group": { "id": "0d073e5f-0ad6-4e6f-a20d-0da242bb5f54", "name": "proident", "slug": "Home", "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png", "url": "http://demo.hivesocialnow.com/Home/" }, "createdOn": "2014-03-03T23:20:23Z", "author": { "id": "898285a4-c6d3-433d-9527-a9bd81e00cd9", "alias": "reprehenderit laborum", "extendedAlias": "aliquip ex eu deserunt nulla", "slug": "Home", "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg", "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/" }, "content": "In incididunt officia anim cillum consequat eu dolor labore esse.", "comment": { "id": 711, "content": "Proident cupidatat cupidatat excepteur ipsum exercitation officia ullamco dolore id Lorem culpa. ", "url": "http://demo.hivesocialnow.com/Home/posts/123#333" }, "post": { "id": "28c22918-cb39-4c76-a411-867cd29def3d", "title": "Esse exercitation ipsum ex labore exercitation consequat.", "summary": "Qui minim eu reprehenderit anim id fugiat et nisi consequat. ", "content": "Incididunt reprehenderit elit incididunt nisi esse sint. ", "slug": "Home", "url": "http://demo.hivesocialnow.com/Home/posts/123" }, "accessWarnings": [] } ] } } The general response properties are described on the Response format page. Here are the list of the specific properties for this method.Method: restore comment revisionAuthorization is required. This method will update the parent comment and will exchange its contents with the revision ones.RequestHTTP requestPOST https://<YOUR_DOMAIN>/api/v1/en_US/revision/comment/{revisionId}/rollbackParametersRequest bodyDo not supply a request body with this method.ResponseIf successful, this method returns a response JSON with the following structure: { "timestamp": "2014-03-03T23:20:23Z", "success": true, "message": "Aliqua anim consequat amet cupidatat proident amet amet.", "errors": [], "object": { "id": 1, "type": "commentRevision", "group": { "id": "0d073e5f-0ad6-4e6f-a20d-0da242bb5f54", "name": "proident", "slug": "Home", "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png", "url": "http://demo.hivesocialnow.com/Home/" }, "createdOn": "2014-03-03T23:20:23Z", "author": { "id": "898285a4-c6d3-433d-9527-a9bd81e00cd9", "alias": "reprehenderit laborum", "extendedAlias": "aliquip ex eu deserunt nulla", "slug": "Home", "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg", "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/" }, "content": "In incididunt officia anim cillum consequat eu dolor labore esse.", "comment": { "id": 711, "content": "Proident cupidatat cupidatat excepteur ipsum exercitation officia ullamco dolore id Lorem culpa. ", "url": "http://demo.hivesocialnow.com/Home/posts/123#333" }, "post": { "id": "28c22918-cb39-4c76-a411-867cd29def3d", "title": "Esse exercitation ipsum ex labore exercitation consequat.", "summary": "Qui minim eu reprehenderit anim id fugiat et nisi consequat. ", "content": "Incididunt reprehenderit elit incididunt nisi esse sint. ", "slug": "Home", "url": "http://demo.hivesocialnow.com/Home/posts/123" }, "accessWarnings": [] } } The general response properties are described on the Response format page. Here are the list of the specific properties for this method.
| property | value | description |
|---|---|---|
| revisionId | integer | The id of the revision you want to restore. |
| property | value | description |
| success | Boolean | Whether the requested operation is successful or not |
| message | String | Human readable error information |
| errors | List (object) | List of validation errors, if any. The "key" property value is matched to one of the record's fields |
| object | object | As the restore process will in fact create a new revision identical to the restored one, this object will contain the newly created revision. |
| property | value | description |
| groupId | guid | The elements group's ID |
| offset | integer | Needed for the infinite scroll functionality. It is the ID of the last presented item to the user. After the request list is generated the system will skip all records from the beginning up to the record with the provided ID (including it). The next batch of records will be returned in the response. |
| pageSize | integer | How many records to be returned by the system. Usually 15 |
| property | value | description |
| id | integer | The id of the post revision. Unique for all revisions not only for one post. |
| group | object | In which group this revision was created |
| createdOn | date | When the revision was created in ISO 8601 string format and UTC time zone |
| author | object | Some common properties of the user that created the revision: id, name, slug, thumbUrl, url (of the group home page) |
| content | string | The content of the revision revision |
| comment | object | The parent element of the revision with some common properties in their current state. |
| post | object | Some common properties of the post under which the comment was posted |
| property | value | description |
| revisionId | integer | The id of the revision you want to restore. |
| property | value | description |
| success | Boolean | Whether the requested operation is successful or not |
| message | String | Human readable error information |
| errors | List (object) | List of validation errors, if any. The "key" property value is matched to one of the record's fields |
| object | object | As the restore process will in fact create a new revision identical to the restored one, this object will contain the newly created revision. |