JavaScript API v3.14

osapi.jive.corev3.BatchResponse

Entity to encapsulate the response to a BatchRequest. Data returned from a call the is a collection of these entities.

ResponseEntities come in three varieties:

Single Entity - The returned entity is available in the data field.

Expanded Results - This variety returned in response to an endpoint specified using a JSON path expression used to expand a collection of entities. The returned collection of BatchResponses is available in the result field.

Error - This variety returned when the endpoint call failed. Error information is available available in the error field.

For a more complete rendition of a batch response, see the page.

Properties

Property	Type	Mode †	Description
`data`	`Object`	read-only	↑ The data returned by this call, if appropriate. If this BatchResponse contains an expanded results collection, the data field is not present.
`error`	`Object`	read-only	↑ An object explaining what went wrong.
`href`	`String`	read-only	↑ The URI of endpoint used in this call. If this BatchResponse contains an expanded results collection, the href field is not present.
`id`	`String`	read-only	↑ The id of this response. The value of this field directly correlates to BatchItem.key. If this BatchResponse is part of an expanded results collection, the id field is not present.
`result`	`BatchResponse[]`	read-only	↑ The collection of expanded results.
`status`	`Integer`	read-only	↑ The HTTP status code returned by this call.