osapi.jive.corev3.BatchRequest

Entity representing the REST endpoint to invoke.

Properties

Properties

PropertyTypeMode Description
endpointStringrequired

The URL to request, or a JSON path expression that references the URL from a prior result.

A JSON path expression is in one of the following forms:

  • ${key:$.path.to.uri} - Used when referencing a single entity.
  • ${key:$.list[*].path.to.uri} - Used to expand multiple entities when the key references a collection.

Where:

  • key is a BatchItem.key that returns a single entity or collection of entities.
  • path.to.uri is a JSON path expression the resolves to a URI in the previously returned entity or collection of entities.

For an example of JSON path expressions, see the page.

methodStringrequired

The HTTP method, or "verb" to execute on the specified endpoint. Supported verbs are:

  • GET
  • PUT
  • POST
  • PATCH
  • DELETE
  • → Fields used by update and create operations
    → Fields used only by create operations
    → Fields not used by update or create operations