API browser of generalFormRequest450 COM module


/images/arrow_right.png IForms::GetObjects method space
This method has a Restful Webservice representation only!
Method for collecting all object data covered by the IForms interface and returned as JSON array.
 
Please note that IForms::GetObjects takes over the functionality of the iterator pair IForms::GetFirstObject / IForms::GetNextObject with a single call, making the latter superfluous.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IForms/GetObjects
[JSON input data] pIForms: longValue,    //interface address
[JSON result array] { pbstrRequestFormID:
pdRequestFormDate:
plRequestFormTimestamp:
pbStatus:
"utf8StringValue",
"stringISODateValue",
longValue,
booleanValue
  },
[HTTP result status] 200 Return status 200 signals a successful method call
204 Return status 204 (noContent) signals that the end of an iteration is reached
>= 400 Return status >= 400 signals an unsuccessful function call. The returned JSON{errorCode: code, errorText:"text"} supplies the error message the same as GetAbortInfo() would do.
space
/images/arrow_right.png Calling argument description
[out] BSTR *pbstrRequestFormID The form ID is the main software's own identification of the form process.

This is one of 3 identifiers that constitute the form object reference.

[out] DATE *pdRequestFormDate The form date is the main software's own date of the form process.

This is one of 3 identifiers that constitute the form object reference.

[out] long *plRequestFormTimestamp This is a UNIX timestamp defined at the moment of the form's infoset generation.

This is one of 3 identifiers that form the form object reference.

[out,retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE then an error occurred and GetAbortInfo should be called to retrieve the error string.
space