Custom_Vision_Training_1.0

UpdateIteration

Update a specific iteration

Select the testing console in the region where you created your resource:

Open API testing console

Request URL

Request parameters

string

Format - uuid. Guid of the projectId

string

Format - uuid. Guid of the iteration

Request headers

string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Profile.

Request body

The updated iteration model

{
  "Id": "string",
  "Name": "string",
  "Status": "string",
  "Created": "string",
  "LastModified": "string",
  "TrainedAt": "string",
  "IsDefault": true
}
{
  "description": "Iteration model to be sent over JSON",
  "type": "object",
  "properties": {
    "Id": {
      "format": "uuid",
      "description": "Gets the id of the iteration",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "Name": {
      "description": "Gets or sets the name of the iteration",
      "type": "string",
      "x-nullable": true
    },
    "Status": {
      "description": "Gets the current iteration status",
      "type": "string",
      "readOnly": true,
      "x-nullable": true
    },
    "Created": {
      "format": "date-time",
      "description": "Gets the time this iteration was completed",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "LastModified": {
      "format": "date-time",
      "description": "Gets the time this iteration was last modified",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "TrainedAt": {
      "format": "date-time",
      "description": "Gets the time this iteration was last modified",
      "type": "string",
      "readOnly": true,
      "x-nullable": true
    },
    "IsDefault": {
      "description": "Gets or sets a value indicating whether the iteration is the default iteration for the project",
      "type": "boolean",
      "x-nullable": false
    }
  },
  "x-nullable": true
}
{
  "Id": "string",
  "Name": "string",
  "Status": "string",
  "Created": "string",
  "LastModified": "string",
  "TrainedAt": "string",
  "IsDefault": true
}
{
  "description": "Iteration model to be sent over JSON",
  "type": "object",
  "properties": {
    "Id": {
      "format": "uuid",
      "description": "Gets the id of the iteration",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "Name": {
      "description": "Gets or sets the name of the iteration",
      "type": "string",
      "x-nullable": true
    },
    "Status": {
      "description": "Gets the current iteration status",
      "type": "string",
      "readOnly": true,
      "x-nullable": true
    },
    "Created": {
      "format": "date-time",
      "description": "Gets the time this iteration was completed",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "LastModified": {
      "format": "date-time",
      "description": "Gets the time this iteration was last modified",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "TrainedAt": {
      "format": "date-time",
      "description": "Gets the time this iteration was last modified",
      "type": "string",
      "readOnly": true,
      "x-nullable": true
    },
    "IsDefault": {
      "description": "Gets or sets a value indicating whether the iteration is the default iteration for the project",
      "type": "boolean",
      "x-nullable": false
    }
  },
  "x-nullable": true
}
<IterationModel>
  <Id>string</Id>
  <Name>string</Name>
  <Status>string</Status>
  <Created>string</Created>
  <LastModified>string</LastModified>
  <TrainedAt>string</TrainedAt>
  <IsDefault>true</IsDefault>
</IterationModel>
{
  "description": "Iteration model to be sent over JSON",
  "type": "object",
  "properties": {
    "Id": {
      "format": "uuid",
      "description": "Gets the id of the iteration",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "Name": {
      "description": "Gets or sets the name of the iteration",
      "type": "string",
      "x-nullable": true
    },
    "Status": {
      "description": "Gets the current iteration status",
      "type": "string",
      "readOnly": true,
      "x-nullable": true
    },
    "Created": {
      "format": "date-time",
      "description": "Gets the time this iteration was completed",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "LastModified": {
      "format": "date-time",
      "description": "Gets the time this iteration was last modified",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "TrainedAt": {
      "format": "date-time",
      "description": "Gets the time this iteration was last modified",
      "type": "string",
      "readOnly": true,
      "x-nullable": true
    },
    "IsDefault": {
      "description": "Gets or sets a value indicating whether the iteration is the default iteration for the project",
      "type": "boolean",
      "x-nullable": false
    }
  },
  "x-nullable": true
}
<IterationModel>
  <Id>string</Id>
  <Name>string</Name>
  <Status>string</Status>
  <Created>string</Created>
  <LastModified>string</LastModified>
  <TrainedAt>string</TrainedAt>
  <IsDefault>true</IsDefault>
</IterationModel>
{
  "description": "Iteration model to be sent over JSON",
  "type": "object",
  "properties": {
    "Id": {
      "format": "uuid",
      "description": "Gets the id of the iteration",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "Name": {
      "description": "Gets or sets the name of the iteration",
      "type": "string",
      "x-nullable": true
    },
    "Status": {
      "description": "Gets the current iteration status",
      "type": "string",
      "readOnly": true,
      "x-nullable": true
    },
    "Created": {
      "format": "date-time",
      "description": "Gets the time this iteration was completed",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "LastModified": {
      "format": "date-time",
      "description": "Gets the time this iteration was last modified",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "TrainedAt": {
      "format": "date-time",
      "description": "Gets the time this iteration was last modified",
      "type": "string",
      "readOnly": true,
      "x-nullable": true
    },
    "IsDefault": {
      "description": "Gets or sets a value indicating whether the iteration is the default iteration for the project",
      "type": "boolean",
      "x-nullable": false
    }
  },
  "x-nullable": true
}

Response 200

OK

{
  "Id": "string",
  "Name": "string",
  "Status": "string",
  "Created": "string",
  "LastModified": "string",
  "TrainedAt": "string",
  "IsDefault": true
}
{
  "description": "Iteration model to be sent over JSON",
  "type": "object",
  "properties": {
    "Id": {
      "format": "uuid",
      "description": "Gets the id of the iteration",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "Name": {
      "description": "Gets or sets the name of the iteration",
      "type": "string",
      "x-nullable": true
    },
    "Status": {
      "description": "Gets the current iteration status",
      "type": "string",
      "readOnly": true,
      "x-nullable": true
    },
    "Created": {
      "format": "date-time",
      "description": "Gets the time this iteration was completed",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "LastModified": {
      "format": "date-time",
      "description": "Gets the time this iteration was last modified",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "TrainedAt": {
      "format": "date-time",
      "description": "Gets the time this iteration was last modified",
      "type": "string",
      "readOnly": true,
      "x-nullable": true
    },
    "IsDefault": {
      "description": "Gets or sets a value indicating whether the iteration is the default iteration for the project",
      "type": "boolean",
      "x-nullable": false
    }
  },
  "x-nullable": true
}
{
  "Id": "string",
  "Name": "string",
  "Status": "string",
  "Created": "string",
  "LastModified": "string",
  "TrainedAt": "string",
  "IsDefault": true
}
{
  "description": "Iteration model to be sent over JSON",
  "type": "object",
  "properties": {
    "Id": {
      "format": "uuid",
      "description": "Gets the id of the iteration",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "Name": {
      "description": "Gets or sets the name of the iteration",
      "type": "string",
      "x-nullable": true
    },
    "Status": {
      "description": "Gets the current iteration status",
      "type": "string",
      "readOnly": true,
      "x-nullable": true
    },
    "Created": {
      "format": "date-time",
      "description": "Gets the time this iteration was completed",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "LastModified": {
      "format": "date-time",
      "description": "Gets the time this iteration was last modified",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "TrainedAt": {
      "format": "date-time",
      "description": "Gets the time this iteration was last modified",
      "type": "string",
      "readOnly": true,
      "x-nullable": true
    },
    "IsDefault": {
      "description": "Gets or sets a value indicating whether the iteration is the default iteration for the project",
      "type": "boolean",
      "x-nullable": false
    }
  },
  "x-nullable": true
}
<IterationModel>
  <Id>string</Id>
  <Name>string</Name>
  <Status>string</Status>
  <Created>string</Created>
  <LastModified>string</LastModified>
  <TrainedAt>string</TrainedAt>
  <IsDefault>true</IsDefault>
</IterationModel>
{
  "description": "Iteration model to be sent over JSON",
  "type": "object",
  "properties": {
    "Id": {
      "format": "uuid",
      "description": "Gets the id of the iteration",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "Name": {
      "description": "Gets or sets the name of the iteration",
      "type": "string",
      "x-nullable": true
    },
    "Status": {
      "description": "Gets the current iteration status",
      "type": "string",
      "readOnly": true,
      "x-nullable": true
    },
    "Created": {
      "format": "date-time",
      "description": "Gets the time this iteration was completed",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "LastModified": {
      "format": "date-time",
      "description": "Gets the time this iteration was last modified",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "TrainedAt": {
      "format": "date-time",
      "description": "Gets the time this iteration was last modified",
      "type": "string",
      "readOnly": true,
      "x-nullable": true
    },
    "IsDefault": {
      "description": "Gets or sets a value indicating whether the iteration is the default iteration for the project",
      "type": "boolean",
      "x-nullable": false
    }
  },
  "x-nullable": true
}
<IterationModel>
  <Id>string</Id>
  <Name>string</Name>
  <Status>string</Status>
  <Created>string</Created>
  <LastModified>string</LastModified>
  <TrainedAt>string</TrainedAt>
  <IsDefault>true</IsDefault>
</IterationModel>
{
  "description": "Iteration model to be sent over JSON",
  "type": "object",
  "properties": {
    "Id": {
      "format": "uuid",
      "description": "Gets the id of the iteration",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "Name": {
      "description": "Gets or sets the name of the iteration",
      "type": "string",
      "x-nullable": true
    },
    "Status": {
      "description": "Gets the current iteration status",
      "type": "string",
      "readOnly": true,
      "x-nullable": true
    },
    "Created": {
      "format": "date-time",
      "description": "Gets the time this iteration was completed",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "LastModified": {
      "format": "date-time",
      "description": "Gets the time this iteration was last modified",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "TrainedAt": {
      "format": "date-time",
      "description": "Gets the time this iteration was last modified",
      "type": "string",
      "readOnly": true,
      "x-nullable": true
    },
    "IsDefault": {
      "description": "Gets or sets a value indicating whether the iteration is the default iteration for the project",
      "type": "boolean",
      "x-nullable": false
    }
  },
  "x-nullable": true
}

Code samples

@ECHO OFF

curl -v -X PATCH "https://chinanorth.api.cognitive.azure.cn/customvision/v1.0/Training/projects/{projectId}/iterations/{iterationId}"
-H "Content-Type: application/json"
-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://chinanorth.api.cognitive.azure.cn/customvision/v1.0/Training/projects/{projectId}/iterations/{iterationId}?" + queryString;

        }
    }
}	
// // 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://chinanorth.api.cognitive.azure.cn/customvision/v1.0/Training/projects/{projectId}/iterations/{iterationId}");


            URI uri = builder.build();
            HttpPatch request = new HttpPatch(uri);
            request.setHeader("Content-Type", "application/json");
            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://chinanorth.api.cognitive.azure.cn/customvision/v1.0/Training/projects/{projectId}/iterations/{iterationId}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Training-key","{subscription key}");
            },
            type: "PATCH",
            // 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://chinanorth.api.cognitive.azure.cn/customvision/v1.0/Training/projects/{projectId}/iterations/{iterationId}";
    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:@"PATCH"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_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://chinanorth.api.cognitive.azure.cn/customvision/v1.0/Training/projects/{projectId}/iterations/{iterationId}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'Training-key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_PATCH);

// 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
    'Content-Type': 'application/json',
    'Training-key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('chinanorth.api.cognitive.azure.cn')
    conn.request("PATCH", "/customvision/v1.0/Training/projects/{projectId}/iterations/{iterationId}?%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
    'Content-Type': 'application/json',
    'Training-key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('chinanorth.api.cognitive.azure.cn')
    conn.request("PATCH", "/customvision/v1.0/Training/projects/{projectId}/iterations/{iterationId}?%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://chinanorth.api.cognitive.azure.cn/customvision/v1.0/Training/projects/{projectId}/iterations/{iterationId}')
uri.query = URI.encode_www_form({
})

request = Net::HTTP::Patch.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# 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