BXMSDOC-4192-master: Add note about API calls for process instances in KIE APIs doc.

[sterobin]

See JIRA for details.

[mswiderski]

both FQCN and simple name of the class would work e.g. com.myspace.Person and Person

about the null variable, isn't that it will be a map instead of expected type instead of null?

[sterobin]

@mswiderski, how about this then:

For REST API requests that send complex data objects to the process instance endpoint `/server/containers/{containerId}/processes/{processId}/instances`, ensure that you include either the fully qualified class name (such as `com.myspace.Person`) or the simple class name (such as `Person`) in the request body. The class name is required for the request body to be mapped to the correct business object in {PRODUCT}. If you exclude the class name from the request, {KIE_SERVER} does not unmarshall the object to the expected type.

I have no clue about the KIE server behavior if the name is excluded. That's just what Michael said in RHPAM-1917.

[mswiderski]

I'd add when sending complex data object to the message as it is only needed when data are of not simple types. About the null process variable maybe it would be better to state it won't be unmarshalled to expected type.

[sterobin]

@mswiderski, I see. I've revised the note in my previous comment accordingly ^^. How about that?

[mswiderski]

looks good

[sterobin]

Thanks @mswiderski. Also, as part of this, can you likewise update the Body parameter description in the Swagger source for this endpoint to mention the same? This way it's in both Swagger itself and in the s2m rendering when users look up the endpoints.

Like this:

Body | Optional map of process variables. Requires fully qualified class name or simple class name.

[Update]

@mswiderski, thoughts on this? Seems like a good idea, imo.

[kie-qe-ci]

Can one of the admins verify this PR? Comment with 'ok to test' to start the build.