Create a draft and remove it

Remove a draft of an object by using the DestroyDraft method.

The children of the draft object (if any) are removed as well.

This method can be used to cancel the work on the draft of an object. For example, if you had created a draft of a sheet that is published, you might not want anymore to replace the published sheet.

Example

Prerequisite: A non-published app is opened. The handle of the app is 1.

The steps are the following:

Creation of a sheet in the app.
Add a child to the sheet.
Publish the app (the sheet is published at the same time).
Create a draft of the sheet.
Remove the draft.

1. Create a sheet of identifier Sheet01 (qId is Sheet01). qChildListDef is added to the definition of the sheet in order to be able to list the children of the sheet.

The client sends:

{ "jsonrpc": "2.0", "id": 3, "method": "CreateObject", "handle": 1, "params": [ { "title": "Sheet 1", "description": "Description of sheet 1", "qInfo": { "qId": "Sheet01", "qType": "sheet" }, "qChildListDef": { "qData": { "title": "/title", "description": "/description", "meta": "/meta", "order": "/order", "id": "/qInfo/qId", "type": "/qInfo/qType", "lb": "/qListObjectDef", "hc": "/qHyperCubeDef" } } } ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 3, "result": { "qReturn": { "qType": "GenericObject", "qHandle": 2 }, "qInfo": { "qId": "Sheet01", "qType": "sheet" } }, "change": [ 2 ] }

The sheet Sheet01 is created and has 2 as a handle.

CreateObject method.

2. Create a child in the sheet. The child is a list object with identifier LB01 (qId is LB01). The handle of the request is 2 because the sheet has 2 as a handle. A title and a description are added. The name of the field is Country (qFieldDefs is Country).

The client sends:

{ "jsonrpc": "2.0", "id": 4, "method": "CreateChild", "handle": 2, "params": [ { "qInfo": { "qId": "LB01", "qType": "ListObject" }, "qListObjectDef": { "qStateName": "$", "qLibraryId": "", "qDef": { "qFieldDefs": [ "Country" ], "qFieldLabels": [ "Country Label" ], "qSortCriterias": [ { "qSortByLoadOrder": 1 } ] }, "qInitialDataFetch": [ { "qTop": 0, "qHeight": 1, "qLeft": 0, "qWidth": 1 } ] }, "title": "A listObject", "description": "Description of the listObject" } ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 4, "result": { "qReturn": { "qType": "GenericObject", "qHandle": 3 }, "qInfo": { "qId": "LB01", "qType": "ListObject" } }, "change": [ 3 ] }

The list object is created and has 3 as a handle.

CreateChild method.

3. Publish the app. The handle of the request is 1 because the Publish method applies at app level. The name of the published app is Golf Quest.qvf. The first parameter in the request corresponds to the identifier of the stream where the app is published.

The client sends:

{ "jsonrpc": "2.0", "id": 5, "method": "Publish", "handle": 1, "params": [ "9b9ec1f7-005c-4974-9468-3482db318087", "Golf Quest.qvf" ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 5, "result": {} }

The app and all its objects are published, which means that the sheet Sheet01 is also published. The published sheet contains one object, which is the list object LB01.

Publish method.

4. Create a draft of the published sheet. The identifier of the sheet is Sheet01.

The client sends:

{ "jsonrpc": "2.0", "id": 6, "method": "CreateDraft", "handle": 1, "params": [ "Sheet01" ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 6, "result": { "qDraftId": "c983fbd2-686a-4003-933d-c4979bfc1aae" } }

The draft is created. The identifier of the draft (qDraftId) is returned.

CreateDraft method.

5. Remove the draft. The first parameter is the identifier of the draft. The second parameter is the identifier of the source object (the object from which the draft was created).

The client sends:

{ "jsonrpc": "2.0", "id": 8, "method": "DestroyDraft", "handle": 1, "params": [ "8783dbbe-22a7-4934-a33b-4efc0ce768ec", "Sheet01" ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 8, "result": { "qSuccess": true }, "change": [ 2, 3 ], "close": [ 4 ] }

The draft of the sheet Sheet01 is successfully removed (qSucess is true).

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here