Custom_Vision_Training_3.3
GetProjects
Get your projects.
Select the testing console in the region where you created your resource:
Open API testing consoleRequest URL
Request headers
Request body
Response 200
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"settings": {
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
],
"useNegativeSet": true,
"detectionParameters": "string",
"imageProcessingSettings": {
"augmentationMethods": {}
}
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true,
"status": "Succeeded"
}
]{
"type": "array",
"items": {
"description": "Represents a project.",
"required": [
"name",
"description",
"settings"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Gets the project id.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"name": {
"description": "Gets or sets the name of the project.",
"type": "string",
"readOnly": false,
"x-nullable": false
},
"description": {
"description": "Gets or sets the description of the project.",
"type": "string",
"readOnly": false,
"x-nullable": true
},
"settings": {
"description": "Gets or sets the project settings.",
"type": "object",
"properties": {
"domainId": {
"format": "uuid",
"description": "Gets or sets the id of the Domain to use with this project.",
"type": "string",
"readOnly": false,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"classificationType": {
"description": "Gets or sets the classification type of the project.",
"enum": [
"Multiclass",
"Multilabel"
],
"type": "string",
"readOnly": false,
"x-nullable": true,
"x-ms-enum": {
"name": "Classifier",
"modelAsString": true
}
},
"targetExportPlatforms": {
"description": "A list of ExportPlatform that the trained model should be able to support.",
"type": "array",
"items": {
"enum": [
"CoreML",
"TensorFlow",
"DockerFile",
"ONNX",
"VAIDK"
],
"type": "string",
"x-nullable": false
},
"readOnly": false
},
"useNegativeSet": {
"description": "Indicates if negative set is being used.",
"type": "boolean",
"readOnly": true,
"x-nullable": true
},
"detectionParameters": {
"description": "Detection parameters in use, if any.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"imageProcessingSettings": {
"description": "Gets or sets image preprocessing settings.",
"type": "object",
"properties": {
"augmentationMethods": {
"description": "Gets or sets enabled image transforms. The key corresponds to the transform name. If value is set to true, then correspondent transform is enabled. Otherwise this transform will not be used.\r\nAugmentation will be uniformly distributed among enabled transforms.",
"type": "object",
"additionalProperties": {
"type": "boolean"
},
"readOnly": false,
"x-nullable": true
}
},
"readOnly": false
}
},
"readOnly": false
},
"created": {
"format": "date-time",
"description": "Gets the date this project was created.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"lastModified": {
"format": "date-time",
"description": "Gets the date this project was last modified.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"thumbnailUri": {
"description": "Gets the thumbnail url representing the 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
},
"drModeEnabled": {
"description": "Gets if the Disaster Recovery (DR) mode is on, indicating the project is temporarily read-only.",
"type": "boolean",
"readOnly": true,
"x-nullable": true
},
"status": {
"description": "Gets the status of the project.",
"enum": [
"Succeeded",
"Importing",
"Failed"
],
"type": "string",
"readOnly": false,
"x-nullable": false,
"x-ms-enum": {
"name": "ProjectStatus",
"modelAsString": true
}
}
}
}
}<ProjectArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</ProjectArray>{
"type": "array",
"items": {
"description": "Represents a project.",
"required": [
"name",
"description",
"settings"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Gets the project id.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"name": {
"description": "Gets or sets the name of the project.",
"type": "string",
"readOnly": false,
"x-nullable": false
},
"description": {
"description": "Gets or sets the description of the project.",
"type": "string",
"readOnly": false,
"x-nullable": true
},
"settings": {
"description": "Gets or sets the project settings.",
"type": "object",
"properties": {
"domainId": {
"format": "uuid",
"description": "Gets or sets the id of the Domain to use with this project.",
"type": "string",
"readOnly": false,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"classificationType": {
"description": "Gets or sets the classification type of the project.",
"enum": [
"Multiclass",
"Multilabel"
],
"type": "string",
"readOnly": false,
"x-nullable": true,
"x-ms-enum": {
"name": "Classifier",
"modelAsString": true
}
},
"targetExportPlatforms": {
"description": "A list of ExportPlatform that the trained model should be able to support.",
"type": "array",
"items": {
"enum": [
"CoreML",
"TensorFlow",
"DockerFile",
"ONNX",
"VAIDK"
],
"type": "string",
"x-nullable": false
},
"readOnly": false
},
"useNegativeSet": {
"description": "Indicates if negative set is being used.",
"type": "boolean",
"readOnly": true,
"x-nullable": true
},
"detectionParameters": {
"description": "Detection parameters in use, if any.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"imageProcessingSettings": {
"description": "Gets or sets image preprocessing settings.",
"type": "object",
"properties": {
"augmentationMethods": {
"description": "Gets or sets enabled image transforms. The key corresponds to the transform name. If value is set to true, then correspondent transform is enabled. Otherwise this transform will not be used.\r\nAugmentation will be uniformly distributed among enabled transforms.",
"type": "object",
"additionalProperties": {
"type": "boolean"
},
"readOnly": false,
"x-nullable": true
}
},
"readOnly": false
}
},
"readOnly": false
},
"created": {
"format": "date-time",
"description": "Gets the date this project was created.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"lastModified": {
"format": "date-time",
"description": "Gets the date this project was last modified.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"thumbnailUri": {
"description": "Gets the thumbnail url representing the 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
},
"drModeEnabled": {
"description": "Gets if the Disaster Recovery (DR) mode is on, indicating the project is temporarily read-only.",
"type": "boolean",
"readOnly": true,
"x-nullable": true
},
"status": {
"description": "Gets the status of the project.",
"enum": [
"Succeeded",
"Importing",
"Failed"
],
"type": "string",
"readOnly": false,
"x-nullable": false,
"x-ms-enum": {
"name": "ProjectStatus",
"modelAsString": true
}
}
}
}
}<ProjectArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</ProjectArray>{
"type": "array",
"items": {
"description": "Represents a project.",
"required": [
"name",
"description",
"settings"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Gets the project id.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"name": {
"description": "Gets or sets the name of the project.",
"type": "string",
"readOnly": false,
"x-nullable": false
},
"description": {
"description": "Gets or sets the description of the project.",
"type": "string",
"readOnly": false,
"x-nullable": true
},
"settings": {
"description": "Gets or sets the project settings.",
"type": "object",
"properties": {
"domainId": {
"format": "uuid",
"description": "Gets or sets the id of the Domain to use with this project.",
"type": "string",
"readOnly": false,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"classificationType": {
"description": "Gets or sets the classification type of the project.",
"enum": [
"Multiclass",
"Multilabel"
],
"type": "string",
"readOnly": false,
"x-nullable": true,
"x-ms-enum": {
"name": "Classifier",
"modelAsString": true
}
},
"targetExportPlatforms": {
"description": "A list of ExportPlatform that the trained model should be able to support.",
"type": "array",
"items": {
"enum": [
"CoreML",
"TensorFlow",
"DockerFile",
"ONNX",
"VAIDK"
],
"type": "string",
"x-nullable": false
},
"readOnly": false
},
"useNegativeSet": {
"description": "Indicates if negative set is being used.",
"type": "boolean",
"readOnly": true,
"x-nullable": true
},
"detectionParameters": {
"description": "Detection parameters in use, if any.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"imageProcessingSettings": {
"description": "Gets or sets image preprocessing settings.",
"type": "object",
"properties": {
"augmentationMethods": {
"description": "Gets or sets enabled image transforms. The key corresponds to the transform name. If value is set to true, then correspondent transform is enabled. Otherwise this transform will not be used.\r\nAugmentation will be uniformly distributed among enabled transforms.",
"type": "object",
"additionalProperties": {
"type": "boolean"
},
"readOnly": false,
"x-nullable": true
}
},
"readOnly": false
}
},
"readOnly": false
},
"created": {
"format": "date-time",
"description": "Gets the date this project was created.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"lastModified": {
"format": "date-time",
"description": "Gets the date this project was last modified.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"thumbnailUri": {
"description": "Gets the thumbnail url representing the 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
},
"drModeEnabled": {
"description": "Gets if the Disaster Recovery (DR) mode is on, indicating the project is temporarily read-only.",
"type": "boolean",
"readOnly": true,
"x-nullable": true
},
"status": {
"description": "Gets the status of the project.",
"enum": [
"Succeeded",
"Importing",
"Failed"
],
"type": "string",
"readOnly": false,
"x-nullable": false,
"x-ms-enum": {
"name": "ProjectStatus",
"modelAsString": true
}
}
}
}
}Response 500
Error response
{
"code": "NoError",
"message": "string"
}{
"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",
"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",
"ErrorInvalid"
],
"type": "string",
"x-ms-enum": {
"name": "CustomVisionErrorCodes",
"modelAsString": true
}
},
"message": {
"description": "A message explaining the error reported by the service.",
"type": "string"
}
}
}<CustomVisionError>
<code>NoError</code>
<message>string</message>
</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",
"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",
"ErrorInvalid"
],
"type": "string",
"x-ms-enum": {
"name": "CustomVisionErrorCodes",
"modelAsString": true
}
},
"message": {
"description": "A message explaining the error reported by the service.",
"type": "string"
}
}
}<CustomVisionError>
<code>NoError</code>
<message>string</message>
</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",
"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",
"ErrorInvalid"
],
"type": "string",
"x-ms-enum": {
"name": "CustomVisionErrorCodes",
"modelAsString": true
}
},
"message": {
"description": "A message explaining the error reported by the service.",
"type": "string"
}
}
}Code samples
@ECHO OFF
curl -v -X GET "https://*.cognitiveservices.azure.com/customvision/v3.3/Training/projects"
-H "Training-key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Training-key", "{subscription key}");
var uri = "https://*.cognitiveservices.azure.com/customvision/v3.3/Training/projects?" + queryString;
var response = await client.GetAsync(uri);
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://*.cognitiveservices.azure.com/customvision/v3.3/Training/projects");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Training-key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://*.cognitiveservices.azure.com/customvision/v3.3/Training/projects?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Training-key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://*.cognitiveservices.azure.com/customvision/v3.3/Training/projects";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Training-key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://*.cognitiveservices.azure.com/customvision/v3.3/Training/projects');
$url = $request->getUrl();
$headers = array(
// Request headers
'Training-key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Training-key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('*.cognitiveservices.azure.com')
conn.request("GET", "/customvision/v3.3/Training/projects?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Training-key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('*.cognitiveservices.azure.com')
conn.request("GET", "/customvision/v3.3/Training/projects?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://*.cognitiveservices.azure.com/customvision/v3.3/Training/projects')
uri.query = URI.encode_www_form({
})
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Training-key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body