# Elastic access request in the context of a session

Makes an elastic access request in the context of a session.

Endpoint: PUT /v1.0/sessions/{sessionId}
Version: 1.0
Security: AdministrationAccess, ClientAccess

## Header parameters:

  - `x-instance-id` (string)
    UUID of the instance the session is linked to. Required by requests that use a ClientAccess token.

## Path parameters:

  - `sessionId` (string, required)
    UUID of the session where the access request is being made.

## Request fields (application/json):

  - `requester` (object, required)
    Requester details

  - `requester.type` (string, required)
    Type of the requester.

  - `requester.value` (string, required)
    Unique identifier for the requester.

  - `requester.dictionary` (object)
    Dictionary of additional information about the requester. Will be used to evaluate actions defined on line items.

  - `rollbackOnDeny` (boolean, required)
    When true, if the request cannot be granted the session will revert to the combination of items it was charging for before the request was made. When false, if the request cannot be granted the session will refund all items it was charging for before the request was made, and the session state will be set to TERMINATED. The amount refunded will be calculated using the time of the denied request up until the end of the period that has been charged for.

  - `requestedItems` (array, required)
    A list of requested items. Provide an empty list to stop using all items.

  - `requestedItems.item` (string, required)
    The requested item.

  - `requestedItems.version` (string)
    The version of the item requested. This field may only be omitted or left blank if the intention is to access an item in a rate table with an empty or unspecified version.

  - `requestedItems.count` (number, required)
    Number of instances of the requested item required. The value can be fractional.

  - `requestedItems.metaData` (object)
    (Optional) For sending custom data with the request, which will be sent to the data warehouse with the usage information to assist with analyzing access activity. The meta data content must be a valid JSON object.

## Response 200 fields (application/json):

  - `requestedItems` (array)
    List of requested items.

  - `requestedItems.count` (number)
    Number of instances of the requested item granted. The value can be fractional.

  - `requestedItems.item` (string)
    The name of a requested item.

  - `requestedItems.version` (string)
    The version of a requested item.

  - `requestedItems.totalTokensCharged` (number)
    Total number of tokens charged across all line items. The value can be fractional.

  - `requestedItems.lineItems` (array)
    List of line items charged to fulfill this request.

  - `requestedItems.lineItems.rate` (number)
    Rate applied. The value can be fractional.

  - `requestedItems.lineItems.activationId` (string)
    Activation ID of line item charged to fulfill the request.

  - `requestedItems.lineItems.tokensCharged` (number)
    Number of tokens charged. The value can be fractional.

  - `requestedItems.lineItems.actionId` (string)
    Unique identifier of the action and allocation used if the access request was fulfilled from an allocation within the line item.

  - `requestedItems.status` (object)
    The response status to the request for the specific item.

  - `requestedItems.status.code` (string)
    Possible values
* 101 (Successfully checked out)
* 102 (No Status)
* 201 (Item not found in any effective rate table)
* 301 (No valid active line items)
* 306 (Insufficient count available)
* 4001 (Failed due to internal server error) There was an internal error processing the request. If you need to contact support, please include the correlationId provided in the response.

  - `requestedItems.status.description` (string)
    A user-readable message explaining the status code.
    Example: "Successfully checked out."

  - `requester` (object)
    The details of the requester making the access request.

  - `requester.type` (string, required)
    Type of the requester.

  - `requester.value` (string, required)
    Unique identifier for the requester.

  - `requester.dictionary` (object)
    Dictionary of additional information about the requester. Will be used to evaluate actions defined on line items.

  - `correlationId` (string)
    An ID for the request, generated by the service, which allows correlation of the request with usage information obtained from the data warehouse. The correlation ID cannot be set by the caller of the API.