Interface Loas

All Known Implementing Classes:
LoasImpl
@Beta public interface Loas
Digital Letters of Authorization (LOAs) (10 operations).

Obtain it from fabric.beta().loas(). Every operation maps one Fabric v4 endpoint; the Javadoc of each method names the path and the spec operation id.

Beta: Fabric v4 4.34.0 (spec read 2026-11-11).

Generated from the Fabric v4 OpenAPI spec by the fabric-beta generator; regenerate rather than hand-edit.

  • Method Details

    • create

      LoaResponse create(CreateLoa request)
      Create Loa: POST /fabric/v4/loas (operation createLoa).

      The API provides capability to create a new Loa

      Parameters:
      request - the CreateLoa request body
      Returns:
      the LoaResponse the API returns

    • getByUuid

      LoaResponse getByUuid(String loaId)
      Get Loa: GET /fabric/v4/loas/{loaId} (operation getLoaByUuid).

      The API provides capability to get Loa details by Loa ID

      Parameters:
      loaId - the loaId path parameter
      Returns:
      the LoaResponse the API returns

    • update

      LoaResponse update(String loaId, List<PatchOperation> operations)
      Update Loa: PATCH /fabric/v4/loas/{loaId} (operation updateLoaByUuid).

      The API provides capability to update Loa details by Loa ID

      Sent as application/json-patch+json, per the spec. Patchable paths named by the spec: /demarcationPoint/cageUniqueSpaceId, /demarcationPoint/connectorType, /demarcationPoint/patchPanelId, /demarcationPoint/patchPanelPortA, /demarcationPoint/patchPanelPortB, /description, /expirationDateTime, /issuer/email, /issuer/orgName, /location/ibxCode, /name, /requestor/email, /requestor/orgName.

      Parameters:
      loaId - the loaId path parameter
      operations - the patch operations (op/path/value)
      Returns:
      the LoaResponse the API returns

    • performAction

      LoaActionResponse performAction(String loaId, LoaActionRequest request)
      Create LOA Action: POST /fabric/v4/loas/{loaId}/actions (operation performLoaAction).

      The API provides capability to perform actions on Loa

      Parameters:
      loaId - the loaId path parameter
      request - the LoaActionRequest request body
      Returns:
      the LoaActionResponse the API returns

    • getAction

      LoaActionResponse getAction(String loaId, String actionId)
      Get Loa Action by Action ID: GET /fabric/v4/loas/{loaId}/actions/{actionId} (operation getLoaActionsByUuid).

      This API provides capability to fetch action details

      Parameters:
      loaId - the loaId path parameter
      actionId - the actionId path parameter
      Returns:
      the LoaActionResponse the API returns

    • search

      PaginatedFilteredList<LoaResponse> search(FilterPropertyList filter, SortPropertyList sort)
      Search Loas: POST /fabric/v4/loas/search (operation searchLoa).

      The API provides capability to get list of user's Loa using search criteria, including optional filtering, pagination and sorting

      Filter properties named by the spec: /authorizedProductType, /changeLog/createdDateTime, /changeLog/updatedDateTime, /demarcationPoint/cageUniqueSpaceId, /demarcationPoint/connectorType, /demarcationPoint/patchPanelId, /demarcationPoint/patchPanelPortA, /demarcationPoint/patchPanelPortB, /expirationDateTime, /issuer/email, /issuer/orgId, /issuer/orgName, /location/ibxCode, /name, /requestor/email, /requestor/orgId, /requestor/orgName, /state, /type, /uuid.

      Sort properties named by the spec: /changeLog/createdDateTime, /changeLog/updatedDateTime, /expirationDateTime, /name.

      Parameters:
      filter - the filter (null for none)
      sort - the sort order (null for the service default)
      Returns:
      a lazily paged list of LoaResponse

    • search

      PaginatedFilteredList<LoaResponse> search(FilterPropertyList filter)
      Search Loas: POST /fabric/v4/loas/search (operation searchLoa).

      The API provides capability to get list of user's Loa using search criteria, including optional filtering, pagination and sorting

      Parameters:
      filter - the filter (null for none)
      Returns:
      a lazily paged list of LoaResponse

    • search

      PaginatedFilteredList<LoaResponse> search()
      Search Loas: POST /fabric/v4/loas/search (operation searchLoa).

      The API provides capability to get list of user's Loa using search criteria, including optional filtering, pagination and sorting

      Returns:
      a lazily paged list of LoaResponse

    • searchActions

      PaginatedFilteredList<LoaActionResponse> searchActions(String loaId, FilterPropertyList filter, SortPropertyList sort)
      Search Loa Actions: POST /fabric/v4/loas/{loaId}/actions/search (operation searchLoaAction).

      The API provides capability to get list of user's Loa Actions using search criteria, including optional filtering, pagination and sorting

      Filter properties named by the spec: /state, /type, /uuid.

      Sort properties named by the spec: /changeLog/createdDateTime.

      Parameters:
      loaId - the loaId path parameter
      filter - the filter (null for none)
      sort - the sort order (null for the service default)
      Returns:
      a lazily paged list of LoaActionResponse

    • searchActions

      PaginatedFilteredList<LoaActionResponse> searchActions(String loaId, FilterPropertyList filter)
      Search Loa Actions: POST /fabric/v4/loas/{loaId}/actions/search (operation searchLoaAction).

      The API provides capability to get list of user's Loa Actions using search criteria, including optional filtering, pagination and sorting

      Parameters:
      loaId - the loaId path parameter
      filter - the filter (null for none)
      Returns:
      a lazily paged list of LoaActionResponse

    • searchActions

      PaginatedFilteredList<LoaActionResponse> searchActions(String loaId)
      Search Loa Actions: POST /fabric/v4/loas/{loaId}/actions/search (operation searchLoaAction).

      The API provides capability to get list of user's Loa Actions using search criteria, including optional filtering, pagination and sorting

      Parameters:
      loaId - the loaId path parameter
      Returns:
      a lazily paged list of LoaActionResponse

    • getConsumers

      List<LoaConsumer> getConsumers(String loaId)
      Get Loa Consumers: GET /fabric/v4/loas/{loaId}/consumers (operation getLoaConsumersByLoaId).

      The API provides capability to get Loa consumers by Loa ID

      Unwraps the LoaConsumersResponse data envelope (the spec documents no paging for it).

      Parameters:
      loaId - the loaId path parameter
      Returns:
      the LoaConsumer entries (empty when none)

    • getNotes

      List<LoaNoteDetails> getNotes(String loaId)
      Get Loa Notes: GET /fabric/v4/loas/{loaId}/notes (operation getLoaNotesByUuid).

      The API provides capability to get Loa notes by Loa ID

      Unwraps the LoaNotesResponse data envelope (the spec documents no paging for it).

      Parameters:
      loaId - the loaId path parameter
      Returns:
      the LoaNoteDetails entries (empty when none)

    • createNote

      LoaNoteDetails createNote(String loaId, CreateLoaNote request)
      Create Loa Note: POST /fabric/v4/loas/{loaId}/notes (operation createLoaNoteByLoaId).

      The API provides capability to create Loa note by Loa ID

      Parameters:
      loaId - the loaId path parameter
      request - the CreateLoaNote request body
      Returns:
      the LoaNoteDetails the API returns