Skip to content

Commit

Permalink
Fixed apiary doc: document content
Browse files Browse the repository at this point in the history
  • Loading branch information
fabrizyo committed Jan 14, 2016
1 parent 40d58a6 commit 8db5a37
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions apiary.apib
Original file line number Diff line number Diff line change
Expand Up @@ -342,18 +342,18 @@ Each parameter is seen as a resource (subresource of parameters) and is uniquely



## The content subresource [/restful-services/2.0/documents/{document_label}/content]
## The content subresource: document execution [/restful-services/2.0/documents/{document_label}/content]

In SpagoBI a document can be executed. For a point of view, executing a document can be seen as the act of retrieving its content. For this reason, the content of a document is represented as a sub resource of it.
In SpagoBI a document can be executed. For a point of view, executing a document can be seen as the act of retrieving its content. For this reason, the content of a document is represented as a subresource of it.

+ Parameters
+ document_label (string) - the document's label


### Return the document content [POST]

In order to execute the document you must put them inside the body payload as a JSON object. There is also the outputType parameter represented as queryParameter.
It accepts an "outputType" query parameter, for example "HTML".
In order to execute the document you must put the document's parameters inside the body payload as a JSON object. There is also the outputType parameter represented as queryParameter.
It accepts an output type, for example "HTML" or "PDF". The available output types depend from the kind of document. Check the available export types from the SpagoBI web application, inside the view of document.

+ Request (application/json)

Expand All @@ -362,10 +362,10 @@ It accepts an "outputType" query parameter, for example "HTML".
[
{
"id":"1",
"label":"label1",
"type":"type1",
"urlName":"myUrl",
"values":["v1","v2"]
"label":"Country",
"type":"string",
"urlName":"country",
"values":["Italy","USA"]
}
]

Expand Down

0 comments on commit 8db5a37

Please sign in to comment.