swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ImageApi API
schemes:
- https
tags:
- name: ImageApi
paths:
  /projects/{projectId}/images:
    get:
      tags:
      - ImageApi
      summary: Microsoft Azure Get Images For A Given Project Iteration Or Workspace
      description: This API supports batching and range selection. By default it will only return first 50 images matching images.<br>Use the {take} and {skip} parameters to control how many images to return in a given batch.<br>The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and<br>"Cat" tags, then only images tagged with Dog and/or Cat will be returned
      operationId: microsoftAzureGetimages
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: iterationId
        in: query
        description: The iteration id. Defaults to workspace.
        required: false
        type: string
        format: uuid
      - name: tagIds
        in: query
        description: A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.
        required: false
        type: array
        items:
          type: string
          format: uuid
          x-nullable: false
        collectionFormat: csv
        maxItems: 20
        minItems: 0
      - name: taggingStatus
        in: query
        description: The tagging status filter. It can be 'All', 'Tagged', or 'Untagged'. Defaults to 'All'.
        required: false
        type: string
        enum:
        - All
        - Tagged
        - Untagged
      - name: $filter
        in: query
        description: "An expression to filter the images against image metadata. Only images where the expression evaluates to true are included in the response.\r\nThe expression supports eq (Equal), ne (Not equal), and (Logical and), or (Logical or) operators.\r\nHere is an example, metadata=key1 eq 'value1' and key2 ne 'value2'."
        required: false
        type: string
      - name: orderBy
        in: query
        description: The ordering. Defaults to newest.
        required: false
        type: string
        enum:
        - Newest
        - Oldest
      - name: take
        in: query
        description: Maximum number of images to return. Defaults to 50, limited to 256.
        required: false
        type: integer
        format: int32
        default: 50
        maximum: 256
        minimum: 0
      - name: skip
        in: query
        description: Number of images to skip before beginning the image batch. Defaults to 0.
        required: false
        type: integer
        format: int32
        default: 0
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Image'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful GetImages request:
          $ref: ./examples/GetImages.json
    post:
      tags:
      - ImageApi
      summary: Microsoft Azure Add The Provided Images To The Set Of Training Images
      description: This API accepts body content as multipart/form-data and application/octet-stream. When using multipart<br>multiple image files can be sent at once, with a maximum of 64 files.<br>If all images are successful created, 200(OK) status code will be returned.<br>Otherwise, 207 (Multi-Status) status code will be returned and detail status for each image will be listed in the response payload.
      operationId: microsoftAzureCreateimagesfromdata
      consumes:
      - multipart/form-data
      - application/octet-stream
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: tagIds
        in: query
        description: The tags ids with which to tag each image. Limited to 20.
        required: false
        type: array
        items:
          type: string
          format: uuid
          x-nullable: false
        collectionFormat: csv
        maxItems: 20
        minItems: 0
      - name: imageData
        in: formData
        description: Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.
        required: true
        type: file
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ImageCreateSummary'
        '207':
          description: '207'
          schema:
            $ref: '#/definitions/ImageCreateSummary'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful CreateImagesFromData request:
          $ref: ./examples/CreateImagesFromData.json
    delete:
      tags:
      - ImageApi
      summary: Microsoft Azure Delete Images From The Set Of Training Images
      operationId: microsoftAzureDeleteimages
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: imageIds
        in: query
        description: Ids of the images to be deleted. Limited to 256 images per batch.
        required: false
        type: array
        items:
          type: string
          format: uuid
          x-nullable: false
        collectionFormat: csv
        maxItems: 256
        minItems: 0
      - name: allImages
        in: query
        description: Flag to specify delete all images, specify this flag or a list of images. Using this flag will return a 202 response to indicate the images are being deleted.
        required: false
        type: boolean
      - name: allIterations
        in: query
        description: Removes these images from all iterations, not just the current workspace. Using this flag will return a 202 response to indicate the images are being deleted.
        required: false
        type: boolean
      responses:
        '202':
          description: Accepted
        '204':
          description: No Content
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful DeleteImages request:
          $ref: ./examples/DeleteImages.json
      description: Needs a more full description created.
  /projects/{projectId}/images/count:
    get:
      tags:
      - ImageApi
      summary: Microsoft Azure Get The Number Of Images
      description: The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and<br>"Cat" tags, then only images tagged with Dog and/or Cat will be returned
      operationId: microsoftAzureGetimagecount
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: iterationId
        in: query
        description: The iteration id. Defaults to workspace.
        required: false
        type: string
        format: uuid
      - name: taggingStatus
        in: query
        description: The tagging status filter. It can be 'All', 'Tagged', or 'Untagged'. Defaults to 'All'.
        required: false
        type: string
        enum:
        - All
        - Tagged
        - Untagged
      - name: $filter
        in: query
        description: "An expression to filter the images against image metadata. Only images where the expression evaluates to true are included in the response.\r\nThe expression supports eq (Equal), ne (Not equal), and (Logical and), or (Logical or) operators.\r\nHere is an example, metadata=key1 eq 'value1' and key2 ne 'value2'."
        required: false
        type: string
      - name: tagIds
        in: query
        description: A list of tags ids to filter the images to count. Defaults to all tags when null.
        required: false
        type: array
        items:
          type: string
          format: uuid
          x-nullable: false
        collectionFormat: csv
      responses:
        '200':
          description: OK
          schema:
            format: int32
            type: integer
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful GetImageCount request:
          $ref: ./examples/GetImageCount.json
  /projects/{projectId}/images/files:
    post:
      tags:
      - ImageApi
      summary: Microsoft Azure Add The Provided Batch Of Images To The Set Of Training Images
      description: This API accepts a batch of files, and optionally tags, to create images. There is a limit of 64 images and 20 tags.<br>If all images are successful created, 200(OK) status code will be returned.<br>Otherwise, 207 (Multi-Status) status code will be returned and detail status for each image will be listed in the response payload.
      operationId: microsoftAzureCreateimagesfromfiles
      consumes:
      - application/json
      - application/xml
      - text/xml
      - application/x-www-form-urlencoded
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: batch
        in: body
        description: The batch of image files to add. Limited to 64 images and 20 tags per batch.
        required: true
        schema:
          $ref: '#/definitions/ImageFileCreateBatch'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ImageCreateSummary'
        '207':
          description: '207'
          schema:
            $ref: '#/definitions/ImageCreateSummary'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful CreateImagesFromFiles request:
          $ref: ./examples/CreateImagesFromFiles.json
  /projects/{projectId}/images/id:
    get:
      tags:
      - ImageApi
      summary: Microsoft Azure Get Images By Id For A Given Project Iteration
      description: This API will return a set of Images for the specified tags and optionally iteration. If no iteration is specified the<br>current workspace is used.
      operationId: microsoftAzureGetimagesbyids
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: imageIds
        in: query
        description: The list of image ids to retrieve. Limited to 256.
        required: false
        type: array
        items:
          type: string
          format: uuid
          x-nullable: false
        collectionFormat: csv
        maxItems: 256
        minItems: 0
      - name: iterationId
        in: query
        description: The iteration id. Defaults to workspace.
        required: false
        type: string
        format: uuid
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Image'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful GetImagesByIds request:
          $ref: ./examples/GetImagesByIds.json
  /projects/{projectId}/images/metadata:
    post:
      tags:
      - ImageApi
      summary: Microsoft Azure Update Metadata Of Images
      description: This API accepts a batch of image Ids, and metadata, to update images. There is a limit of 64 images.
      operationId: microsoftAzureUpdateimagemetadata
      consumes:
      - application/json
      - application/xml
      - text/xml
      - application/x-www-form-urlencoded
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: imageIds
        in: query
        description: The list of image ids to update. Limited to 64.
        required: true
        type: array
        items:
          type: string
          format: uuid
          x-nullable: false
        collectionFormat: csv
        maxItems: 256
        minItems: 0
      - name: metadata
        in: body
        description: The metadata to be updated to the specified images. Limited to 50 key-value pairs per image. The length of key is limited to 256. The length of value is limited to 512.
        required: true
        schema:
          type: object
          additionalProperties:
            type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ImageMetadataUpdateSummary'
        '207':
          description: '207'
          schema:
            $ref: '#/definitions/ImageMetadataUpdateSummary'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful UpdateImageMetadata request:
          $ref: ./examples/UpdateImageMetadata.json
  /projects/{projectId}/images/predictions:
    post:
      tags:
      - ImageApi
      summary: Microsoft Azure Add The Specified Predicted Images To The Set Of Training Images
      description: This API creates a batch of images from predicted images specified. There is a limit of 64 images and 20 tags.<br>If all images are successful created, 200(OK) status code will be returned.<br>Otherwise, 207 (Multi-Status) status code will be returned and detail status for each image will be listed in the response payload.
      operationId: microsoftAzureCreateimagesfrompredictions
      consumes:
      - application/json
      - application/xml
      - text/xml
      - application/x-www-form-urlencoded
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: batch
        in: body
        description: Image, tag ids, and metadata. Limited to 64 images and 20 tags per batch.
        required: true
        schema:
          $ref: '#/definitions/ImageIdCreateBatch'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ImageCreateSummary'
        '207':
          description: '207'
          schema:
            $ref: '#/definitions/ImageCreateSummary'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful CreateImagesFromPredictions request:
          $ref: ./examples/CreateImagesFromPredictions.json
  /projects/{projectId}/images/regions:
    post:
      tags:
      - ImageApi
      summary: Microsoft Azure Create A Set Of Image Regions
      description: This API accepts a batch of image regions, and optionally tags, to update existing images with region information.<br>There is a limit of 64 entries in the batch.<br>If all regions are successful created, 200(OK) status code will be returned.<br>Otherwise, 207 (Multi-Status) status code will be returned and detail status for each region will be listed in the response payload.
      operationId: microsoftAzureCreateimageregions
      consumes:
      - application/json
      - application/xml
      - text/xml
      - application/x-www-form-urlencoded
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: batch
        in: body
        description: Batch of image regions which include a tag and bounding box. Limited to 64.
        required: true
        schema:
          $ref: '#/definitions/ImageRegionCreateBatch'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ImageRegionCreateSummary'
        '207':
          description: '207'
          schema:
            $ref: '#/definitions/ImageRegionCreateSummary'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful CreateImageRegions request:
          $ref: ./examples/CreateImageRegions.json
    delete:
      tags:
      - ImageApi
      summary: Microsoft Azure Delete A Set Of Image Regions
      operationId: microsoftAzureDeleteimageregions
      consumes: []
      produces: []
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: regionIds
        in: query
        description: Regions to delete. Limited to 64.
        required: true
        type: array
        items:
          type: string
          format: uuid
          x-nullable: false
        collectionFormat: csv
        maxItems: 64
        minItems: 0
      responses:
        '204':
          description: No Content
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful DeleteImageRegions request:
          $ref: ./examples/DeleteImageRegions.json
      description: Needs a more full description created.
  /projects/{projectId}/images/suggested:
    post:
      tags:
      - ImageApi
      summary: Microsoft Azure Get Untagged Images Whose Suggested Tags Match Given Tags Returns Empty Array If No Images Are Found
      description: This API will fetch untagged images filtered by suggested tags Ids. It returns an empty array if no images are found.
      operationId: microsoftAzureQuerysuggestedimages
      consumes:
      - application/json
      - application/xml
      - text/xml
      - application/x-www-form-urlencoded
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: iterationId
        in: query
        description: IterationId to use for the suggested tags and regions.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: query
        in: body
        description: Contains properties we need to query suggested images.
        required: true
        schema:
          $ref: '#/definitions/SuggestedTagAndRegionQueryToken'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SuggestedTagAndRegionQuery'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful QuerySuggestedImages request:
          $ref: ./examples/QuerySuggestedImages.json
  /projects/{projectId}/images/suggested/count:
    post:
      tags:
      - ImageApi
      summary: Microsoft Azure Get Count Of Images Whose Suggested Tags Match Given Tags And Their Probabilities Are Greater Than Or Equal To The Given Threshold Returns Count As 0 If None Found
      description: This API takes in tagIds to get count of untagged images per suggested tags for a given threshold.
      operationId: microsoftAzureQuerysuggestedimagecount
      consumes:
      - application/json
      - application/xml
      - text/xml
      - application/x-www-form-urlencoded
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: iterationId
        in: query
        description: IterationId to use for the suggested tags and regions.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: query
        in: body
        description: Model that contains tagIds, threshold and projectType to query by.
        required: true
        schema:
          $ref: '#/definitions/TagFilter'
      responses:
        '200':
          description: OK
          schema:
            type: object
            additionalProperties:
              format: int32
              type: integer
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful QuerySuggestedImageCount request:
          $ref: ./examples/QuerySuggestedImageCount.json
  /projects/{projectId}/images/tagged:
    get:
      tags:
      - ImageApi
      summary: Microsoft Azure Get Tagged Images For A Given Project Iteration
      description: This API supports batching and range selection. By default it will only return first 50 images matching images.<br>Use the {take} and {skip} parameters to control how many images to return in a given batch.<br>The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and<br>"Cat" tags, then only images tagged with Dog and/or Cat will be returned
      operationId: microsoftAzureGettaggedimages
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: iterationId
        in: query
        description: The iteration id. Defaults to workspace.
        required: false
        type: string
        format: uuid
      - name: tagIds
        in: query
        description: A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.
        required: false
        type: array
        items:
          type: string
          format: uuid
          x-nullable: false
        collectionFormat: csv
        maxItems: 20
        minItems: 0
      - name: orderBy
        in: query
        description: The ordering. Defaults to newest.
        required: false
        type: string
        enum:
        - Newest
        - Oldest
      - name: take
        in: query
        description: Maximum number of images to return. Defaults to 50, limited to 256.
        required: false
        type: integer
        format: int32
        default: 50
        maximum: 256
        minimum: 0
      - name: skip
        in: query
        description: Number of images to skip before beginning the image batch. Defaults to 0.
        required: false
        type: integer
        format: int32
        default: 0
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Image'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful GetTaggedImages request:
          $ref: ./examples/GetTaggedImages.json
  /projects/{projectId}/images/tagged/count:
    get:
      tags:
      - ImageApi
      summary: Microsoft Azure Gets The Number Of Images Tagged With The Provided {tagids}
      description: The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and<br>"Cat" tags, then only images tagged with Dog and/or Cat will be returned
      operationId: microsoftAzureGettaggedimagecount
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: iterationId
        in: query
        description: The iteration id. Defaults to workspace.
        required: false
        type: string
        format: uuid
      - name: tagIds
        in: query
        description: A list of tags ids to filter the images to count. Defaults to all tags when null.
        required: false
        type: array
        items:
          type: string
          format: uuid
          x-nullable: false
        collectionFormat: csv
      responses:
        '200':
          description: OK
          schema:
            format: int32
            type: integer
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful GetTaggedImageCount request:
          $ref: ./examples/GetTaggedImageCount.json
  /projects/{projectId}/images/tags:
    post:
      tags:
      - ImageApi
      summary: Microsoft Azure Associate A Set Of Images With A Set Of Tags
      operationId: microsoftAzureCreateimagetags
      consumes:
      - application/json
      - application/xml
      - text/xml
      - application/x-www-form-urlencoded
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: batch
        in: body
        description: Batch of image tags. Limited to 128 tags per batch.
        required: true
        schema:
          $ref: '#/definitions/ImageTagCreateBatch'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ImageTagCreateSummary'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful CreateImageTags request:
          $ref: ./examples/CreateImageTags.json
      description: Needs a more full description created.
    delete:
      tags:
      - ImageApi
      summary: Microsoft Azure Remove A Set Of Tags From A Set Of Images
      operationId: microsoftAzureDeleteimagetags
      consumes: []
      produces: []
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: imageIds
        in: query
        description: Image ids. Limited to 64 images.
        required: true
        type: array
        items:
          type: string
          format: uuid
          x-nullable: false
        collectionFormat: csv
        maxItems: 64
        minItems: 0
      - name: tagIds
        in: query
        description: Tags to be deleted from the specified images. Limited to 20 tags.
        required: true
        type: array
        items:
          type: string
          format: uuid
          x-nullable: false
        collectionFormat: csv
        maxItems: 20
        minItems: 0
      responses:
        '204':
          description: No Content
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful DeleteImageTags request:
          $ref: ./examples/DeleteImageTags.json
      description: Needs a more full description created.
  /projects/{projectId}/images/untagged:
    get:
      tags:
      - ImageApi
      summary: Microsoft Azure Get Untagged Images For A Given Project Iteration
      description: This API supports batching and range selection. By default it will only return first 50 images matching images.<br>Use the {take} and {skip} parameters to control how many images to return in a given batch.
      operationId: microsoftAzureGetuntaggedimages
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: iterationId
        in: query
        description: The iteration id. Defaults to workspace.
        required: false
        type: string
        format: uuid
      - name: orderBy
        in: query
        description: The ordering. Defaults to newest.
        required: false
        type: string
        enum:
        - Newest
        - Oldest
      - name: take
        in: query
        description: Maximum number of images to return. Defaults to 50, limited to 256.
        required: false
        type: integer
        format: int32
        default: 50
        maximum: 256
        minimum: 0
      - name: skip
        in: query
        description: Number of images to skip before beginning the image batch. Defaults to 0.
        required: false
        type: integer
        format: int32
        default: 0
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Image'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful GetUntaggedImages request:
          $ref: ./examples/GetUntaggedImages.json
  /projects/{projectId}/images/untagged/count:
    get:
      tags:
      - ImageApi
      summary: Microsoft Azure Gets The Number Of Untagged Images
      description: This API returns the images which have no tags for a given project and optionally an iteration. If no iteration is specified the<br>current workspace is used.
      operationId: microsoftAzureGetuntaggedimagecount
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: iterationId
        in: query
        description: The iteration id. Defaults to workspace.
        required: false
        type: string
        format: uuid
      responses:
        '200':
          description: OK
          schema:
            format: int32
            type: integer
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful GetUntaggedImageCount request:
          $ref: ./examples/GetUntaggedImageCount.json
  /projects/{projectId}/images/urls:
    post:
      tags:
      - ImageApi
      summary: Microsoft Azure Add The Provided Images Urls To The Set Of Training Images
      description: This API accepts a batch of urls, and optionally tags, to create images. There is a limit of 64 images and 20 tags.<br>If all images are successful created, 200(OK) status code will be returned.<br>Otherwise, 207 (Multi-Status) status code will be returned and detail status for each image will be listed in the response payload.
      operationId: microsoftAzureCreateimagesfromurls
      consumes:
      - application/json
      - application/xml
      - text/xml
      - application/x-www-form-urlencoded
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: projectId
        in: path
        description: The project id.
        required: true
        type: string
        format: uuid
        x-nullable: false
      - name: batch
        in: body
        description: Image urls, tag ids, and metadata. Limited to 64 images and 20 tags per batch.
        required: true
        schema:
          $ref: '#/definitions/ImageUrlCreateBatch'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ImageCreateSummary'
        '207':
          description: '207'
          schema:
            $ref: '#/definitions/ImageCreateSummary'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful CreateImagesFromUrls request:
          $ref: ./examples/CreateImagesFromUrls.json
definitions:
  SuggestedTagAndRegionQuery:
    description: The array of result images and token containing session and continuation Ids for the next query.
    type: object
    properties:
      token:
        $ref: '#/definitions/SuggestedTagAndRegionQueryToken'
        description: Contains properties we need to fetch suggested tags for.
        readOnly: false
      results:
        description: Result of a suggested tags and regions request of the untagged image.
        type: array
        items:
          $ref: '#/definitions/StoredSuggestedTagAndRegion'
          x-nullable: false
        readOnly: true
  ImageUrlCreateEntry:
    required:
    - url
    type: object
    properties:
      url:
        description: Url of the image.
        type: string
        readOnly: false
        x-nullable: false
      tagIds:
        type: array
        items:
          format: uuid
          type: string
          x-nullable: false
        readOnly: false
      regions:
        type: array
        items:
          $ref: '#/definitions/Region'
          x-nullable: false
        readOnly: false
  ImageIdCreateBatch:
    type: object
    properties:
      images:
        type: array
        items:
          $ref: '#/definitions/ImageIdCreateEntry'
          x-nullable: false
        readOnly: false
      tagIds:
        type: array
        items:
          format: uuid
          type: string
          x-nullable: false
        readOnly: false
      metadata:
        description: The metadata of image. Limited to 50 key-value pairs per image. The length of key is limited to 256. The length of value is limited to 512.
        type: object
        additionalProperties:
          type: string
        readOnly: false
        x-nullable: true
  Region:
    required:
    - tagId
    - left
    - top
    - width
    - height
    type: object
    properties:
      tagId:
        format: uuid
        description: Id of the tag associated with this region.
        type: string
        readOnly: false
        x-nullable: false
      left:
        format: float
        description: Coordinate of the left boundary.
        type: number
        readOnly: false
        x-nullable: false
      top:
        format: float
        description: Coordinate of the top boundary.
        type: number
        readOnly: false
        x-nullable: false
      width:
        format: float
        description: Width.
        type: number
        readOnly: false
        x-nullable: false
      height:
        format: float
        description: Height.
        type: number
        readOnly: false
        x-nullable: false
  ImageTagCreateSummary:
    type: object
    properties:
      created:
        type: array
        items:
          $ref: '#/definitions/ImageTagCreateEntry'
        readOnly: false
        x-nullable: true
      duplicated:
        type: array
        items:
          $ref: '#/definitions/ImageTagCreateEntry'
        readOnly: false
        x-nullable: true
      exceeded:
        type: array
        items:
          $ref: '#/definitions/ImageTagCreateEntry'
        readOnly: false
        x-nullable: true
  BoundingBox:
    description: Bounding box that defines a region of an image.
    required:
    - left
    - top
    - width
    - height
    type: object
    properties:
      left:
        format: float
        description: Coordinate of the left boundary.
        type: number
        readOnly: false
        x-nullable: false
      top:
        format: float
        description: Coordinate of the top boundary.
        type: number
        readOnly: false
        x-nullable: false
      width:
        format: float
        description: Width.
        type: number
        readOnly: false
        x-nullable: false
      height:
        format: float
        description: Height.
        type: number
        readOnly: false
        x-nullable: false
  Image:
    description: Image model to be sent as JSON.
    type: object
    properties:
      id:
        format: uuid
        description: Id of the image.
        type: string
        readOnly: true
        example: 00000000-0000-0000-0000-000000000000
        x-nullable: false
      created:
        format: date-time
        description: Date the image was created.
        type: string
        readOnly: true
        x-nullable: false
      width:
        format: int32
        description: Width of the image.
        type: integer
        readOnly: true
        x-nullable: false
      height:
        format: int32
        description: Height of the image.
        type: integer
        readOnly: true
        x-nullable: false
      resizedImageUri:
        description: The URI to the (resized) image used for training. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.
        type: string
        readOnly: true
      thumbnailUri:
        description: The URI to the thumbnail of the original image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.
        type: string
        readOnly: true
      originalImageUri:
        description: The URI to the original uploaded image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.
        type: string
        readOnly: true
      tags:
        description: Tags associated with this image.
        type: array
        items:
          $ref: '#/definitions/ImageTag'
        readOnly: true
        x-nullable: true
      regions:
        description: Regions associated with this image.
        type: array
        items:
          $ref: '#/definitions/ImageRegion'
        readOnly: true
        x-nullable: true
      metadata:
        description: Metadata associated with this image.
        type: object
        additionalProperties:
          type: string
        readOnly: true
        x-nullable: true
  Prediction:
    description: Prediction result.
    type: object
    properties:
      probability:
        format: float
        description: Probability of the tag.
        type: number
        readOnly: true
        x-nullable: false
      tagId:
        format: uuid
        description: Id of the predicted tag.
        type: string
        readOnly: true
        x-nullable: false
      tagName:
        description: Name of the predicted tag.
        type: string
        readOnly: true
        x-nullable: true
      boundingBox:
        $ref: '#/definitions/BoundingBox'
        description: Bounding box of the prediction.
        readOnly: true
        x-nullable: true
      tagType:
        description: Type of the predicted tag.
        enum:
        - Regular
        - Negative
        - GeneralProduct
        type: string
        readOnly: true
        x-nullable: true
        x-ms-enum:
          name: TagType
          modelAsString: true
  ImageRegionCreateResult:
    required:
    - tagId
    - left
    - top
    - width
    - height
    type: object
    properties:
      imageId:
        format: uuid
        type: string
        readOnly: true
        x-nullable: false
      regionId:
        format: uuid
        type: string
        readOnly: true
        x-nullable: false
      tagName:
        type: string
        readOnly: true
        x-nullable: false
      created:
        format: date-time
        type: string
        readOnly: true
        x-nullable: false
      tagId:
        format: uuid
        description: Id of the tag associated with this region.
        type: string
        readOnly: false
        x-nullable: false
      left:
        format: float
        description: Coordinate of the left boundary.
        type: number
        readOnly: false
        x-nullable: false
      top:
        format: float
        description: Coordinate of the top boundary.
        type: number
        readOnly: false
        x-nullable: false
      width:
        format: float
        description: Width.
        type: number
        readOnly: false
        x-nullable: false
      height:
        format: float
        description: Height.
        type: number
        readOnly: false
        x-nullable: false
  ImageTagCreateBatch:
    description: Batch of image tags.
    type: object
    properties:
      tags:
        description: Image Tag entries to include in this batch.
        type: array
        items:
          $ref: '#/definitions/ImageTagCreateEntry'
          x-nullable: false
        readOnly: false
  ImageRegionCreateSummary:
    type: object
    properties:
      created:
        type: array
        items:
          $ref: '#/definitions/ImageRegionCreateResult'
        readOnly: false
        x-nullable: true
      duplicated:
        type: array
        items:
          $ref: '#/definitions/ImageRegionCreateEntry'
        readOnly: false
        x-nullable: true
      exceeded:
        type: array
        items:
          $ref: '#/definitions/ImageRegionCreateEntry'
        readOnly: false
        x-nullable: true
  ImageMetadataUpdateEntry:
    description: Entry associating a metadata to an image.
    type: object
    properties:
      imageId:
        format: uuid
        description: Id of the image.
        type: string
        readOnly: false
        x-nullable: false
      status:
        description: Status of the metadata update.
        enum:
        - OK
        - ErrorImageNotFound
        - ErrorLimitExceed
        - ErrorUnknown
        type: string
        readOnly: false
        x-nullable: false
        x-ms-enum:
          name: ImageMetadataUpdateStatus
          modelAsString: true
      metadata:
        description: Metadata of the image.
        type: object
        additionalProperties:
          type: string
        readOnly: false
        x-nullable: true
  ImageRegionCreateEntry:
    description: Entry associating a region to an image.
    required:
    - imageId
    - tagId
    - left
    - top
    - width
    - height
    type: object
    properties:
      imageId:
        format: uuid
        description: Id of the image.
        type: string
        readOnly: false
        x-nullable: false
      tagId:
        format: uuid
        description: Id of the tag associated with this region.
        type: string
        readOnly: false
        x-nullable: false
      left:
        format: float
        description: Coordinate of the left boundary.
        type: number
        readOnly: false
        x-nullable: false
      top:
        format: float
        description: Coordinate of the top boundary.
        type: number
        readOnly: false
        x-nullable: false
      width:
        format: float
        description: Width.
        type: number
        readOnly: false
        x-nullable: false
      height:
        format: float
        description: Height.
        type: number
        readOnly: false
        x-nullable: false
  ImageTag:
    type: object
    properties:
      tagId:
        format: uuid
        type: string
        readOnly: true
        x-nullable: false
      tagName:
        type: string
        readOnly: true
        x-nullable: false
      created:
        format: date-time
        type: string
        readOnly: true
        x-nullable: false
  TagFilter:
    description: Model that query for counting of images whose suggested tags match given tags and their probability are greater than or equal to the given threshold.
    type: object
    properties:
      tagIds:
        description: Existing TagIds in project to get suggested tags count for.
        type: array
        items:
          format: uuid
          type: string
          x-nullable: false
        readOnly: false
      threshold:
        format: double
        description: Confidence threshold to filter suggested tags on.
        type: number
        readOnly: false
        x-nullable: false
  StoredSuggestedTagAndRegion:
    description: Result of a suggested tags and regions request of the untagged image.
    type: object
    properties:
      width:
        format: int32
        description: Width of the resized image.
        type: integer
        readOnly: true
        x-nullable: false
      height:
        format: int32
        description: Height of the resized image.
        type: integer
        readOnly: true
        x-nullable: false
      resizedImageUri:
        description: The URI to the (resized) prediction image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.
        type: string
        readOnly: true
      thumbnailUri:
        description: The URI to the thumbnail of the original prediction image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.
        type: string
        readOnly: true
      originalImageUri:
        description: The URI to the original prediction image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.
        type: string
        readOnly: true
      domain:
        format: uuid
        description: Domain used for the prediction.
        type: string
        readOnly: true
        x-nullable: false
      id:
        format: uuid
        description: Prediction Id.
        type: string
        readOnly: true
        x-nullable: false
      project:
        format: uuid
        description: Project Id.
        type: string
        readOnly: true
        x-nullable: false
      iteration:
        format: uuid
        description: Iteration Id.
        type: string
        readOnly: true
        x-nullable: false
      created:
        format: date-time
        description: Date this prediction was created.
        type: string
        readOnly: true
        x-nullable: false
      predictions:
        description: List of predictions.
        type: array
        items:
          $ref: '#/definitions/Prediction'
          x-nullable: false
        readOnly: true
      predictionUncertainty:
        format: double
        description: Uncertainty (entropy) of suggested tags or regions per image.
        type: number
        readOnly: true
        x-nullable: false
  ImageCreateSummary:
    type: object
    properties:
      isBatchSuccessful:
        description: True if all of the images in the batch were created successfully, otherwise false.
        type: boolean
        readOnly: true
        x-nullable: false
      images:
        description: List of the image creation results.
        type: array
        items:
          $ref: '#/definitions/ImageCreateResult'
          x-nullable: false
        readOnly: true
  ImageCreateResult:
    type: object
    properties:
      sourceUrl:
        description: Source URL of the image.
        type: string
        readOnly: true
        x-nullable: false
      status:
        description: Status of the image creation.
        enum:
        - OK
        - OKDuplicate
        - ErrorSource
        - ErrorImageFormat
        - ErrorImageSize
        - ErrorStorage
        - ErrorLimitExceed
        - ErrorTagLimitExceed
        - ErrorRegionLimitExceed
        - ErrorUnknown
        - ErrorNegativeAndRegularTagOnSameImage
        type: string
        readOnly: true
        x-nullable: false
        x-ms-enum:
          name: ImageCreateStatus
          modelAsString: true
      image:
        $ref: '#/definitions/Image'
        description: The image.
        readOnly: true
  ImageFileCreateEntry:
    type: object
    properties:
      name:
        type: string
        readOnly: false
        x-nullable: false
      contents:
        format: byte
        type: string
        readOnly: false
      tagIds:
        type: array
        items:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
          x-nullable: false
        readOnly: false
      regions:
        type: array
        items:
          $ref: '#/definitions/Region'
          x-nullable: false
        readOnly: false
  ImageRegion:
    required:
    - tagId
    - left
    - top
    - width
    - height
    type: object
    properties:
      regionId:
        format: uuid
        type: string
        readOnly: true
        x-nullable: false
      tagName:
        type: string
        readOnly: true
        x-nullable: false
      created:
        format: date-time
        type: string
        readOnly: true
        x-nullable: false
      tagId:
        format: uuid
        description: Id of the tag associated with this region.
        type: string
        readOnly: false
        x-nullable: false
      left:
        format: float
        description: Coordinate of the left boundary.
        type: number
        readOnly: false
        x-nullable: false
      top:
        format: float
        description: Coordinate of the top boundary.
        type: number
        readOnly: false
        x-nullable: false
      width:
        format: float
        description: Width.
        type: number
        readOnly: false
        x-nullable: false
      height:
        format: float
        description: Height.
        type: number
        readOnly: false
        x-nullable: false
  ImageTagCreateEntry:
    description: Entry associating a tag to an image.
    type: object
    properties:
      imageId:
        format: uuid
        description: Id of the image.
        type: string
        readOnly: false
        x-nullable: false
      tagId:
        format: uuid
        description: Id of the tag.
        type: string
        readOnly: false
        x-nullable: false
  SuggestedTagAndRegionQueryToken:
    description: "Contains properties we need to fetch suggested tags for. For the first call, Session and continuation set to null.\r\nThen on subsequent calls, uses the session/continuation from the previous SuggestedTagAndRegionQuery result to fetch additional results."
    type: object
    properties:
      tagIds:
        description: Existing TagIds in project to filter suggested tags on.
        type: array
        items:
          format: uuid
          type: string
          x-nullable: false
        readOnly: false
      threshold:
        format: double
        description: Confidence threshold to filter suggested tags on.
        type: number
        readOnly: false
        x-nullable: false
      session:
        description: SessionId for database query. Initially set to null but later used to paginate.
        type: string
        readOnly: false
        x-nullable: false
      continuation:
        description: Continuation Id for database pagination. Initially null but later used to paginate.
        type: string
        readOnly: false
        x-nullable: false
      maxCount:
        format: int32
        description: Maximum number of results you want to be returned in the response.
        type: integer
        readOnly: false
        x-nullable: false
      sortBy:
        description: OrderBy. Ordering mechanism for your results.
        enum:
        - UncertaintyAscending
        - UncertaintyDescending
        type: string
        readOnly: false
        x-nullable: false
        x-ms-enum:
          name: SortBy
          modelAsString: true
  ImageUrlCreateBatch:
    type: object
    properties:
      images:
        type: array
        items:
          $ref: '#/definitions/ImageUrlCreateEntry'
          x-nullable: false
        readOnly: false
      tagIds:
        type: array
        items:
          format: uuid
          type: string
          x-nullable: false
        readOnly: false
      metadata:
        description: The metadata of image. Limited to 50 key-value pairs per image. The length of key is limited to 256. The length of value is limited to 512.
        type: object
        additionalProperties:
          type: string
        readOnly: false
        x-nullable: true
  ImageFileCreateBatch:
    type: object
    properties:
      images:
        type: array
        items:
          $ref: '#/definitions/ImageFileCreateEntry'
          x-nullable: false
        readOnly: false
      tagIds:
        type: array
        items:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
          x-nullable: false
        readOnly: false
      metadata:
        description: The metadata of image. Limited to 50 key-value pairs per image. The length of key is limited to 256. The length of value is limited to 512.
        type: object
        additionalProperties:
          type: string
        readOnly: false
        x-nullable: true
  ImageRegionCreateBatch:
    description: Batch of image region information to create.
    type: object
    properties:
      regions:
        type: array
        items:
          $ref: '#/definitions/ImageRegionCreateEntry'
          x-nullable: false
        readOnly: false
  ImageMetadataUpdateSummary:
    type: object
    properties:
      isBatchSuccessful:
        type: boolean
        readOnly: true
        x-nullable: false
      images:
        type: array
        items:
          $ref: '#/definitions/ImageMetadataUpdateEntry'
          x-nullable: false
        readOnly: true
  ImageIdCreateEntry:
    type: object
    properties:
      id:
        format: uuid
        description: Id of the image.
        type: string
        readOnly: false
        x-nullable: false
      tagIds:
        type: array
        items:
          format: uuid
          type: string
          x-nullable: false
        readOnly: false
      regions:
        type: array
        items:
          $ref: '#/definitions/Region'
          x-nullable: false
        readOnly: false
  CustomVisionError:
    required:
    - code
    - message
    type: object
    properties:
      code:
        description: The error code.
        enum:
        - NoError
        - BadRequest
        - BadRequestExceededBatchSize
        - BadRequestNotSupported
        - BadRequestInvalidIds
        - BadRequestProjectName
        - BadRequestProjectNameNotUnique
        - BadRequestProjectDescription
        - BadRequestProjectUnknownDomain
        - BadRequestProjectUnknownClassification
        - BadRequestProjectUnsupportedDomainTypeChange
        - BadRequestProjectUnsupportedExportPlatform
        - BadRequestProjectImagePreprocessingSettings
        - BadRequestProjectDuplicated
        - BadRequestIterationName
        - BadRequestIterationNameNotUnique
        - BadRequestIterationDescription
        - BadRequestIterationIsNotTrained
        - BadRequestIterationValidationFailed
        - BadRequestWorkspaceCannotBeModified
        - BadRequestWorkspaceNotDeletable
        - BadRequestTagName
        - BadRequestTagNameNotUnique
        - BadRequestTagDescription
        - BadRequestTagType
        - BadRequestMultipleNegativeTag
        - BadRequestMultipleGeneralProductTag
        - BadRequestImageTags
        - BadRequestImageRegions
        - BadRequestNegativeAndRegularTagOnSameImage
        - BadRequestUnsupportedDomain
        - BadRequestRequiredParamIsNull
        - BadRequestIterationIsPublished
        - BadRequestInvalidPublishName
        - BadRequestInvalidPublishTarget
        - BadRequestUnpublishFailed
        - BadRequestIterationNotPublished
        - BadRequestSubscriptionApi
        - BadRequestExceedProjectLimit
        - BadRequestExceedIterationPerProjectLimit
        - BadRequestExceedTagPerProjectLimit
        - BadRequestExceedTagPerImageLimit
        - BadRequestExceededQuota
        - BadRequestCannotMigrateProjectWithName
        - BadRequestNotLimitedTrial
        - BadRequestImageBatch
        - BadRequestImageStream
        - BadRequestImageUrl
        - BadRequestImageFormat
        - BadRequestImageSizeBytes
        - BadRequestImageDimensions
        - BadRequestImageExceededCount
        - BadRequestTrainingNotNeeded
        - BadRequestTrainingNotNeededButTrainingPipelineUpdated
        - BadRequestTrainingValidationFailed
        - BadRequestClassificationTrainingValidationFailed
        - BadRequestMultiClassClassificationTrainingValidationFailed
        - BadRequestMultiLabelClassificationTrainingValidationFailed
        - BadRequestDetectionTrainingValidationFailed
        - BadRequestTrainingAlreadyInProgress
        - BadRequestDetectionTrainingNotAllowNegativeTag
        - BadRequestInvalidEmailAddress
        - BadRequestDomainNotSupportedForAdvancedTraining
        - BadRequestExportPlatformNotSupportedForAdvancedTraining
        - BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining
        - BadRequestExportValidationFailed
        - BadRequestExportAlreadyInProgress
        - BadRequestPredictionIdsMissing
        - BadRequestPredictionIdsExceededCount
        - BadRequestPredictionTagsExceededCount
        - BadRequestPredictionResultsExceededCount
        - BadRequestPredictionInvalidApplicationName
        - BadRequestPredictionInvalidQueryParameters
        - BadRequestInvalidImportToken
        - BadRequestExportWhileTraining
        - BadRequestImageMetadataKey
        - BadRequestImageMetadataValue
        - BadRequestOperationNotSupported
        - BadRequestInvalidArtifactUri
        - BadRequestCustomerManagedKeyRevoked
        - BadRequestInvalid
        - UnsupportedMediaType
        - Forbidden
        - ForbiddenUser
        - ForbiddenUserResource
        - ForbiddenUserSignupDisabled
        - ForbiddenUserSignupAllowanceExceeded
        - ForbiddenUserDoesNotExist
        - ForbiddenUserDisabled
        - ForbiddenUserInsufficientCapability
        - ForbiddenDRModeEnabled
        - ForbiddenInvalid
        - NotFound
        - NotFoundProject
        - NotFoundProjectDefaultIteration
        - NotFoundIteration
        - NotFoundIterationPerformance
        - NotFoundTag
        - NotFoundImage
        - NotFoundDomain
        - NotFoundApimSubscription
        - NotFoundInvalid
        - Conflict
        - ConflictInvalid
        - ErrorUnknown
        - ErrorIterationCopyFailed
        - ErrorPreparePerformanceMigrationFailed
        - ErrorProjectInvalidWorkspace
        - ErrorProjectInvalidPipelineConfiguration
        - ErrorProjectInvalidDomain
        - ErrorProjectTrainingRequestFailed
        - ErrorProjectImportRequestFailed
        - ErrorProjectExportRequestFailed
        - ErrorFeaturizationServiceUnavailable
        - ErrorFeaturizationQueueTimeout
        - ErrorFeaturizationInvalidFeaturizer
        - ErrorFeaturizationAugmentationUnavailable
        - ErrorFeaturizationUnrecognizedJob
        - ErrorFeaturizationAugmentationError
        - ErrorExporterInvalidPlatform
        - ErrorExporterInvalidFeaturizer
        - ErrorExporterInvalidClassifier
        - ErrorPredictionServiceUnavailable
        - ErrorPredictionModelNotFound
        - ErrorPredictionModelNotCached
        - ErrorPrediction
        - ErrorPredictionStorage
        - ErrorRegionProposal
        - ErrorUnknownBaseModel
        - ErrorInvalid
        type: string
        x-ms-enum:
          name: CustomVisionErrorCodes
          modelAsString: true
      message:
        description: A message explaining the error reported by the service.
        type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'