GET Services

GET Services (methods 10)

getDefinitionForFormInstanceWithId: id form: form app: app
"This service is called when a click is performed on the Orbeon Form Summary page (or go directly to edit/view page of a form). The Summary then open the Form Instance in it's corresponding form definition.
	This service is used in combination of #getXmlOfFormInstanceWithId:form:app: to <get> the actual data of the form"
	| orbeonDefinition latestVersionNumber |
	<get>
	<produces: 'application/xml'>
	<path: '/crud/{3}/{2}/form/form.xhtml?document={1}'>

getFormDefinitionWithId: id 
"This service is called when a click is performed on the Orbeon Form Builder Summary page.
The Summary then should open the Orbeon Builder with the code of the clicked form."
	| orbeonData |
	<get>
	<produces: 'application/xml'>
	<path: '/crud/orbeon/builder/data/{1}/data.xml'>

getFormVersion: formName app: app 
"This method is called by Orbeon when a Form Definition (inside the Builder) is about to be Published.
This method answer the latest version of the form definition <formName> in application <app>.
Using the header <orbeon-form-definition-version> to set the version number.
It also called when a new Form Instance page is about to be displayed (app/form/new)"
	| latestVersionNumber |
	<get>
	<produces: 'application/xml'>
	<path: '/crud/{2}/{1}/form/form.xhtml'>

getOrbeonFr
"This service is called when accessing Form Runner Home: ../orbeon/fr/ "
	| xmlWriter |
	<get>
	<produces: 'application/xml'>
	<path: '/form'>

getXmlOfFormDraftWithId: id form: form app: app
"This service is called when a click is performed on the Orbeon Form Summary page.
The Summary then should open the Form Instance (view/edit mode ) in the corresponding form definition (template). This sevice is used in combination with #getDefinitionForFormInstanceWithId:form:app: that <get> the form definition (template) to the form with id <id>"
	| orbeonInstance definition permissions username group |
	<get>
	<produces: 'application/xml'>
	<path: '/crud/{3}/{2}/draft/{1}/data.xml'>

getXmlOfFormInstanceWithId: id form: form app: app
"This service is called when a click is performed on the Orbeon Form Summary page.
The Summary then should open the Form Instance (view/edit mode ) in the corresponding form definition (template).This sevice is used in combination with #getDefinitionForFormInstanceWithId:form:app: that <get> the form definition (template) to the form with id <id>"
	| orbeonInstance definition permissions username group |
	<get>
	<produces: 'application/xml'>
	<path: '/crud/{3}/{2}/data/{1}/data.xml'>

sendFileForDefinitionWithId: definitionId fileId: fileId
"This service receives a file with id <fileId> uploaded into the Form Definition with id <definitionId>"
	| contents gsFile |
	<get>
	<produces: 'application/octet-stream'>
	<path: '/crud/orbeon/builder/data/{1}/{2}'>

sendFileForDraft: formName app: app definitionId: definitionId fileId: fileId
	"This service is called when rendering the Draft of the form in Form Instance page"
	| contents gsFile |
	<get>
	<produces: 'application/octet-stream'>
	<path: '/crud/{2}/{1}/draft/{3}/{4}'>

sendFileForInstance: formName app: app definitionId: definitionId fileId: fileId
"This service is called when inside a Form Instance we want to download the Attachments "
	| contents gsFile |
	<get>
	<produces: 'application/octet-stream'>
	<path: '/crud/{2}/{1}/data/{3}/{4}'>

sendFileForInstance: formName app: app fileId: fileId
	"This service is called when Orbeon requires a Custom PDF of a form"
	| contents gsFile |
	<get>
	<produces: 'application/octet-stream'>
	<path: '/crud/{2}/{1}/form/{3}'>