{
  "opencollection": "1.0.0",
  "info": {
    "name": "Microsoft Azure AccessControlClient AccessConnector ImageApi API",
    "version": "2020-08-01-preview"
  },
  "items": [
    {
      "info": {
        "name": "ImageApi",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Microsoft Azure Get Images For A Given Project Iteration Or Workspace",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/projects/:projectId/images",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The project id."
              },
              {
                "name": "iterationId",
                "value": "",
                "type": "query",
                "description": "The iteration id. Defaults to workspace."
              },
              {
                "name": "tagIds",
                "value": "",
                "type": "query",
                "description": "A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20."
              },
              {
                "name": "taggingStatus",
                "value": "",
                "type": "query",
                "description": "The tagging status filter. It can be 'All', 'Tagged', or 'Untagged'. Defaults to 'All'."
              },
              {
                "name": "$filter",
                "value": "",
                "type": "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'."
              },
              {
                "name": "orderBy",
                "value": "",
                "type": "query",
                "description": "The ordering. Defaults to newest."
              },
              {
                "name": "take",
                "value": "",
                "type": "query",
                "description": "Maximum number of images to return. Defaults to 50, limited to 256."
              },
              {
                "name": "skip",
                "value": "",
                "type": "query",
                "description": "Number of images to skip before beginning the image batch. Defaults to 0."
              }
            ]
          },
          "docs": "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"
        },
        {
          "info": {
            "name": "Microsoft Azure Add The Provided Images To The Set Of Training Images",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/projects/:projectId/images",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The project id."
              },
              {
                "name": "tagIds",
                "value": "",
                "type": "query",
                "description": "The tags ids with which to tag each image. Limited to 20."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Microsoft Azure Delete Images From The Set Of Training Images",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/projects/:projectId/images",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The project id."
              },
              {
                "name": "imageIds",
                "value": "",
                "type": "query",
                "description": "Ids of the images to be deleted. Limited to 256 images per batch."
              },
              {
                "name": "allImages",
                "value": "",
                "type": "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."
              },
              {
                "name": "allIterations",
                "value": "",
                "type": "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."
              }
            ]
          },
          "docs": "Needs a more full description created."
        },
        {
          "info": {
            "name": "Microsoft Azure Get The Number Of Images",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/projects/:projectId/images/count",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The project id."
              },
              {
                "name": "iterationId",
                "value": "",
                "type": "query",
                "description": "The iteration id. Defaults to workspace."
              },
              {
                "name": "taggingStatus",
                "value": "",
                "type": "query",
                "description": "The tagging status filter. It can be 'All', 'Tagged', or 'Untagged'. Defaults to 'All'."
              },
              {
                "name": "$filter",
                "value": "",
                "type": "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'."
              },
              {
                "name": "tagIds",
                "value": "",
                "type": "query",
                "description": "A list of tags ids to filter the images to count. Defaults to all tags when null."
              }
            ]
          },
          "docs": "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"
        },
        {
          "info": {
            "name": "Microsoft Azure Add The Provided Batch Of Images To The Set Of Training Images",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/projects/:projectId/images/files",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The project id."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Microsoft Azure Get Images By Id For A Given Project Iteration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/projects/:projectId/images/id",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The project id."
              },
              {
                "name": "imageIds",
                "value": "",
                "type": "query",
                "description": "The list of image ids to retrieve. Limited to 256."
              },
              {
                "name": "iterationId",
                "value": "",
                "type": "query",
                "description": "The iteration id. Defaults to workspace."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Microsoft Azure Update Metadata Of Images",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/projects/:projectId/images/metadata",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The project id."
              },
              {
                "name": "imageIds",
                "value": "",
                "type": "query",
                "description": "The list of image ids to update. Limited to 64."
              }
            ]
          },
          "docs": "This API accepts a batch of image Ids, and metadata, to update images. There is a limit of 64 images."
        },
        {
          "info": {
            "name": "Microsoft Azure Add The Specified Predicted Images To The Set Of Training Images",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/projects/:projectId/images/predictions",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The project id."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Microsoft Azure Create A Set Of Image Regions",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/projects/:projectId/images/regions",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The project id."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Microsoft Azure Delete A Set Of Image Regions",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/projects/:projectId/images/regions",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The project id."
              },
              {
                "name": "regionIds",
                "value": "",
                "type": "query",
                "description": "Regions to delete. Limited to 64."
              }
            ]
          },
          "docs": "Needs a more full description created."
        },
        {
          "info": {
            "name": "Microsoft Azure Get Untagged Images Whose Suggested Tags Match Given Tags Returns Empty Array If No Images Are Found",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/projects/:projectId/images/suggested",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The project id."
              },
              {
                "name": "iterationId",
                "value": "",
                "type": "query",
                "description": "IterationId to use for the suggested tags and regions."
              }
            ]
          },
          "docs": "This API will fetch untagged images filtered by suggested tags Ids. It returns an empty array if no images are found."
        },
        {
          "info": {
            "name": "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",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/projects/:projectId/images/suggested/count",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The project id."
              },
              {
                "name": "iterationId",
                "value": "",
                "type": "query",
                "description": "IterationId to use for the suggested tags and regions."
              }
            ]
          },
          "docs": "This API takes in tagIds to get count of untagged images per suggested tags for a given threshold."
        },
        {
          "info": {
            "name": "Microsoft Azure Get Tagged Images For A Given Project Iteration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/projects/:projectId/images/tagged",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The project id."
              },
              {
                "name": "iterationId",
                "value": "",
                "type": "query",
                "description": "The iteration id. Defaults to workspace."
              },
              {
                "name": "tagIds",
                "value": "",
                "type": "query",
                "description": "A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20."
              },
              {
                "name": "orderBy",
                "value": "",
                "type": "query",
                "description": "The ordering. Defaults to newest."
              },
              {
                "name": "take",
                "value": "",
                "type": "query",
                "description": "Maximum number of images to return. Defaults to 50, limited to 256."
              },
              {
                "name": "skip",
                "value": "",
                "type": "query",
                "description": "Number of images to skip before beginning the image batch. Defaults to 0."
              }
            ]
          },
          "docs": "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"
        },
        {
          "info": {
            "name": "Microsoft Azure Gets The Number Of Images Tagged With The Provided {tagids}",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/projects/:projectId/images/tagged/count",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The project id."
              },
              {
                "name": "iterationId",
                "value": "",
                "type": "query",
                "description": "The iteration id. Defaults to workspace."
              },
              {
                "name": "tagIds",
                "value": "",
                "type": "query",
                "description": "A list of tags ids to filter the images to count. Defaults to all tags when null."
              }
            ]
          },
          "docs": "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"
        },
        {
          "info": {
            "name": "Microsoft Azure Associate A Set Of Images With A Set Of Tags",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/projects/:projectId/images/tags",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The project id."
              }
            ]
          },
          "docs": "Needs a more full description created."
        },
        {
          "info": {
            "name": "Microsoft Azure Remove A Set Of Tags From A Set Of Images",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/projects/:projectId/images/tags",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The project id."
              },
              {
                "name": "imageIds",
                "value": "",
                "type": "query",
                "description": "Image ids. Limited to 64 images."
              },
              {
                "name": "tagIds",
                "value": "",
                "type": "query",
                "description": "Tags to be deleted from the specified images. Limited to 20 tags."
              }
            ]
          },
          "docs": "Needs a more full description created."
        },
        {
          "info": {
            "name": "Microsoft Azure Get Untagged Images For A Given Project Iteration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/projects/:projectId/images/untagged",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The project id."
              },
              {
                "name": "iterationId",
                "value": "",
                "type": "query",
                "description": "The iteration id. Defaults to workspace."
              },
              {
                "name": "orderBy",
                "value": "",
                "type": "query",
                "description": "The ordering. Defaults to newest."
              },
              {
                "name": "take",
                "value": "",
                "type": "query",
                "description": "Maximum number of images to return. Defaults to 50, limited to 256."
              },
              {
                "name": "skip",
                "value": "",
                "type": "query",
                "description": "Number of images to skip before beginning the image batch. Defaults to 0."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Microsoft Azure Gets The Number Of Untagged Images",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/projects/:projectId/images/untagged/count",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The project id."
              },
              {
                "name": "iterationId",
                "value": "",
                "type": "query",
                "description": "The iteration id. Defaults to workspace."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Microsoft Azure Add The Provided Images Urls To The Set Of Training Images",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/projects/:projectId/images/urls",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The project id."
              }
            ]
          },
          "docs": "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."
        }
      ]
    }
  ],
  "bundled": true
}