PUT Services

PUT Services

duplicateFormDefinitionNewId: id
	"This method is called by Orbeon when a user click 'Send' in a Form Instance page"
	| orbeonInstance |
	<put>
	<produces: 'application/xml'>
	<path: '/crud/orbeon/builder/data/{1}/data.xml'><br><br>```

duplicateFormInstance: formName app: app newId: id<br>
	"This method is called by Orbeon when a user click 'Send' in a Form Instance page"<br>
	| orbeonInstance |<br>
	[put]<br>
	[produces: 'application/xml']<br>
	[path: '/crud/{2}/{1}/data/{3}/data.xml']<br><br>

publishFormDefinition: formName app: app withId: documentId<br>
	"This method is called by Orbeon when a Form Definition has been published with form name <formName> in application <app> with form id <documentId>"<br>
	| orbeonDefinition headerVersion currentVersion |<br>
	[put]<br>
	[consumes: 'application/xml']<br>
	[path: '/crud/{2}/{1}/form/form.xhtml?document={3}']<br><br>

receiveAndPublishFileFor: formName app: app documentId: documentId fileId: fileId<br>
	"This service receives a file with id <fileId> uploaded into the Form Definition with id <definitionId>"<br>
	| gsFile |<br>
	[put]<br>
	[path: '/crud/{2}/{1}/form/{4}?document={3}']<br><br>

receiveAndSaveFileForDefinitionWithId: definitionId fileId: fileId valid: aBoolean<br>
	"This service receives a file with id <fileId> uploaded into the Form Definition with id <definitionId>"<br>
	| stream gsFile |<br>
	[put]<br>
	[path: '/crud/orbeon/builder/data/{1}/{2}.bin?valid={3}']<br><br>

receiveAndSaveFileForDraft: formName app: app definitionId: definitionId fileId: fileId valid: aBoolean<br>
	""<br>
	| stream gsFile |<br>
	[put]<br>
	[path: '/crud/{2}/{1}/draft/{3}/{4}?valid={5}']<br><br>

receiveAndSaveFileForInstance: formName app: app definitionId: definitionId fileId: fileId valid: aBoolean<br>
	""<br>
	| stream gsFile |<br>
	[put]<br>
	[path: '/crud/{2}/{1}/data/{3}/{4}?valid={5}']<br><br>

saveDraftFormInstance: formName app: app withId: id valid: aBoolean<br>
	"This method is called by Orbeon when a user click 'Send' in a Form Instance page"<br>
	| orbeonDraft |<br>
	[put]<br>
	[produces: 'application/xml']<br>
	[path: '/crud/{2}/{1}/draft/{3}/data.xml?valid={4}']<br><br>

saveFinalFormInstance: formName app: app withId: id valid: aBoolean<br>
	"This method is called by Orbeon when a user click 'Send' in a Form Instance page"<br>
	| orbeonInstance |<br>
	[put]<br>
	[produces: 'application/xml']<br>
	[path: '/crud/{2}/{1}/data/{3}/data.xml?valid={4}']<br><br>

saveInFormBuilderDefinitionWithId: id valid: aBoolean<br>
	"This service is called by Orbeon when a user click on -Save- inside the Form Builder.
	A Form Definition has been saved "<br>
	| orbeonData |<br>
	[put]<br>
	[path: '/crud/orbeon/builder/data/{1}/data.xml/?valid={2}']<br><br>

unpublishFormDefinition: formName app: app<br>
	"This method is called by Orbeon when a Form Definition has been unpublished with form name <formName> in application <app>"<br>
	[put]<br>
	[path: '/crud/{2}/{1}/form/form.xhtml']<br>