swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Routesets API
schemes:
- https
tags:
- name: Routesets
paths:
  /routesets:
    post:
      summary: Microsoft Azure Use To Create A Routeset
      description: <br><br>The `Create` API is an HTTP `POST` request that allows the caller to create a routeset from a dataset. The routeset is a data structure consumed by the Azure Maps [Wayfinding](/rest/api/maps-creator/wayfinding) service to discover the shortest paths within a facility.<br><br>The Create Routeset API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).<br><br>Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDKs. See the [Creator for indoor maps](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article for an introduction to the Azure Maps Creator concepts and tools.<br><br>### Submit Create Request<br><br>To create a routeset, make a `POST` request with an empty body. The dataset is used as the source of the routeset data, so the `datasetId` query parameter must be included.
      operationId: microsoftAzureRoutesetCreate
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        'Create a routeset from a previously created dataset ':
          $ref: ./examples/wayfind/Routeset_Create.json
      parameters:
      - $ref: ../../../Common/preview/1.0/common.json#/parameters/ClientId
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/RouteDatasetId'
      - $ref: '#/parameters/Description'
      responses:
        '202':
          $ref: ../../../Common/preview/1.0/common.json#/responses/202AsyncV2
        default:
          $ref: ../../../Common/preview/1.0/common.json#/responses/default
      tags:
      - Routesets
    get:
      summary: Microsoft Azure Use To Get A List Of Routesets
      description: <br><br>Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDKs. See the [Creator for indoor maps](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article for an introduction to the Azure Maps Creator concepts and tools.<br><br>### Submit List Request<br><br>The `List` API is an HTTP `GET` request that allows the caller to fetch a list of all routesets in the current Azure Maps Creator account.
      operationId: microsoftAzureRoutesetList
      x-ms-examples:
        Enumerate all routesets for a given subscription:
          $ref: ./examples/wayfind/Routeset_List.json
      parameters:
      - $ref: ../../../Common/preview/1.0/common.json#/parameters/ClientId
      - $ref: '#/parameters/ApiVersion'
      x-ms-pageable:
        itemName: routesets
        nextLinkName: nextLink
      responses:
        '200':
          description: List routeset request completed successfully. The response body contains a list of all routesets.
          schema:
            $ref: '#/definitions/RoutesetsList'
        default:
          $ref: ../../../Common/preview/1.0/common.json#/responses/default
      tags:
      - Routesets
  /routesets/{routesetId}:
    get:
      summary: Microsoft Azure Use To Get The Details Of A Routeset
      description: <br><br>Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDKs. See the [Creator for indoor maps](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article for an introduction to the Azure Maps Creator concepts and tools.<br><br>### Submit Get Request<br><br>The `Get` API is an HTTP `GET` request that allows the caller to fetch the details of an existing routeset, specified by the `routesetId`.
      operationId: microsoftAzureRoutesetGet
      x-ms-examples:
        Get details for a previously created dataset:
          $ref: ./examples/wayfind/Routeset_Get.json
      parameters:
      - $ref: ../../../Common/preview/1.0/common.json#/parameters/ClientId
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/QueryRoutesetId'
      responses:
        '200':
          description: The get routeset request completed successfully.
          schema:
            $ref: '#/definitions/Routeset'
        default:
          $ref: ../../../Common/preview/1.0/common.json#/responses/default
      tags:
      - Routesets
    delete:
      summary: Microsoft Azure Use To Delete A Routeset
      description: <br><br>Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDKs. See the [Creator for indoor maps](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article for an introduction to the Azure Maps Creator concepts and tools.<br><br>### Submit Delete Request<br><br>The `Delete` API is an HTTP `DELETE` request sent with the `routesetId` of the routeset to delete.
      operationId: microsoftAzureRoutesetDelete
      x-ms-examples:
        Delete an existing routeset:
          $ref: ./examples/wayfind/Routeset_Delete.json
      parameters:
      - $ref: '#/parameters/DeleteRoutesetId'
      - $ref: ../../../Common/preview/1.0/common.json#/parameters/ClientId
      - $ref: '#/parameters/ApiVersion'
      responses:
        '204':
          description: Routeset delete request completed successfully.
        default:
          $ref: ../../../Common/preview/1.0/common.json#/responses/default
      tags:
      - Routesets
  /routesets/operations/{operationId}:
    get:
      summary: Microsoft Azure Use To Check The Status Of The Routeset Creation Process
      description: <br><br>The `Get Operation` API is an HTTP `GET` request used to check the status of the routeset creation process and retrieve the `routesetId`.<br><br>### Submit Operations Request<br><br>To view the current progress of a routeset operation, you will use a `GET` request where the `operationId` given the path is the ID that represents the operation.<br><br>### Operation Response<br><br>While in progress, a `200-OK` http status code is returned with no extra headers. If the operation succeeds, a `200-OK` http status code is returned with the `Resource-Location` in the header.
      operationId: microsoftAzureRoutesetGetoperation
      x-ms-examples:
        Get the status of an operation which is still running:
          $ref: ./examples/wayfind/Routeset_GetOperationStillRunning.json
        Get the status of an operation which has finished successfully:
          $ref: ./examples/wayfind/Routeset_GetOperation.json
      parameters:
      - $ref: ../../../Common/preview/1.0/common.json#/parameters/ClientId
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/OperationId'
      responses:
        '200':
          description: The operation is running or complete. If the operation was successful, use the Resource-Location header to obtain the path to the result.
          schema:
            $ref: ./tileset.json#/definitions/LongRunningOperationResult
          headers:
            Resource-Location:
              type: string
              description: If successful, a URI where details on the newly created resource can be found.
        default:
          $ref: ../../../Common/preview/1.0/common.json#/responses/default
      tags:
      - Routesets
definitions:
  Routeset:
    description: Detailed information for the routeset.
    type: object
    properties:
      routesetId:
        description: The unique ID of the routeset.
        type: string
        readOnly: true
      datasetId:
        description: The ID of the dataset used to create this routeset.
        type: string
        readOnly: true
      description:
        description: The description code for the building with the ontology version number.
        type: string
        readOnly: true
      facilities:
        description: The facility information and building level ordinal numbers.
        type: array
        items:
          $ref: '#/definitions/FacilityDetails'
        x-ms-identifiers: []
        readOnly: true
      created:
        description: The date and time the routeset object was created.
        type: string
        format: date-time
        readOnly: true
  RoutesetsList:
    description: The response model for the Routeset List API. Returns the list of all routesets.
    type: object
    properties:
      routesets:
        description: The list of all routesets.
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/Routeset'
      nextLink:
        description: If present, the location of the next page of data.
        type: string
        readOnly: true
  FacilityDetails:
    description: Details about each facility in the routeset.
    type: object
    properties:
      facilityId:
        description: The identifier of the structure this routeset was created from.
        type: string
        readOnly: true
      levelOrdinals:
        description: The level identifiers within this facility.
        type: array
        items:
          type: number
        x-ms-identifiers: []
        readOnly: true
parameters:
  RouteDatasetId:
    name: datasetId
    type: string
    in: query
    description: The ID of the dataset from which to create the routeset(s). A routeset is created for each facility in the dataset.
    required: true
    x-ms-parameter-location: method
  Description:
    name: description
    description: User provided description of the routeset.
    type: string
    in: query
    x-ms-parameter-location: client
  QueryRoutesetId:
    name: routesetId
    description: The ID of the routeset to query for.
    type: string
    in: path
    required: true
    x-ms-parameter-location: method
  ApiVersion:
    name: api-version
    description: Version number of Azure Maps API.
    type: string
    in: query
    required: true
    x-ms-parameter-location: client
  OperationId:
    name: operationId
    description: The ID used to query the status of the routeset creation.
    type: string
    in: path
    required: true
    x-ms-parameter-location: method
  DeleteRoutesetId:
    name: routesetId
    description: The ID of the routeset to delete.
    type: string
    in: path
    required: true
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'