Create Deployment task.

Creates a new Deployment task with the specified configuration.

Endpoints

post /emsapi/osdeployer/tasks

Copy full URL

Request URL

https://{server-hostname}:8383/emsapi/osdeployer/tasks

Scope

OSDTask.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/deploymentTaskDetails.v1+jsonCopied!

AcceptstringMandatory

application/deploymentTaskCreatedStatus.v1+jsonCopied!

- Request Body

application/deploymentTaskDetails.v1+json

JSON Object

Request body for creating a new deployment task.

Hide Sub-Attributes

taskNamestringMandatory

Display name of the deployment task. Matches uem_fileName regex.

templateIDlongMandatory

Deployment template ID that defines the image and post-deployment actions.

taskDescriptionstringMandatory

Free-form description of the task. Pass an empty string if no description is needed.

authCodestringOptional

One-time authorization code for agent enrolment. Required at the commit step (PUT /tasks/{taskId}), not at creation.

applicableRemoteOfficesarrayOptional

Remote-office IDs the task is allowed to target. If omitted or empty, the task targets all offices.

taskSettingsJSON ObjectOptional

Broadcast type, bandwidth limit, wait time, and schedule details for the task.

Show Sub-Attributes

broadcastTypeintegerMandatory

Broadcast mode: 0 = Unicast, 1 = Multicast. Sending any other value returns INVALID_APPLICATIONS_TYPE.

bandwidthlongMandatory

Maximum bandwidth per target in kbps.

waitTimelongMandatory

Time in minutes to wait for clients to join before starting transmission.

scheduleDetailsJSON ObjectOptional

Schedule for the task start (one-time or recurring).

Show Sub-Attributes

startTimelongOptional

Epoch-millis timestamp at which the task should start.

remoteOfficeIdlongOptional

Primary remote office that schedules and runs the task.

mediaIdlongOptional

ID of the OS Deployer boot media to be used by the task.

resourceIDsarrayOptional

OS Deployer resource IDs to be targeted by the task.

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/emsapi/osdeployer/tasks \
  --header 'Accept: application/deploymentTaskCreatedStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/deploymentTaskDetails.v1+json' \
  --data '{"taskDescription":"","taskName":"DeploymentTask6","templateID":1}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/emsapi/osdeployer/tasks"))
        .header("Content-Type", "application/deploymentTaskDetails.v1+json")
        .header("Accept", "application/deploymentTaskCreatedStatus.v1+json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"taskDescription\":\"\",\"taskName\":\"DeploymentTask6\",\"templateID\":1}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"taskDescription\":\"\",\"taskName\":\"DeploymentTask6\",\"templateID\":1}"

headers = {
    'Content-Type': "application/deploymentTaskDetails.v1+json",
    'Accept': "application/deploymentTaskCreatedStatus.v1+json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/emsapi/osdeployer/tasks", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/deploymentTaskDetails.v1+json");
    headersMap.put("Accept", "application/deploymentTaskCreatedStatus.v1+json");

    data=Map();
    data.put("taskName","value");
    data.put("templateID","1");
    data.put("taskDescription","value");
    data.put("authCode","value");
    data_applicableRemoteOffices=List();
    data_applicableRemoteOffices.add("1");
    data.put("applicableRemoteOffices",data_applicableRemoteOffices);
    data_taskSettings=Map();
    data_taskSettings.put("broadcastType","1");
    data_taskSettings.put("bandwidth","1");
    data_taskSettings.put("waitTime","1");
    data_taskSettings_scheduleDetails=Map();
    data_taskSettings_scheduleDetails.put("startTime","1");
    data_taskSettings.put("scheduleDetails",data_taskSettings_scheduleDetails);
    data.put("taskSettings",data_taskSettings);
    data.put("remoteOfficeId","1");
    data.put("mediaId","1");
    data_resourceIDs=List();
    data_resourceIDs.add("1");
    data.put("resourceIDs",data_resourceIDs);

    response = invokeUrl
    [
        url: "https://appDomain/emsapi/osdeployer/tasks"
        type: POST
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/deploymentTaskDetails.v1+json")
$headers.Add("Accept", "application/deploymentTaskCreatedStatus.v1+json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/emsapi/osdeployer/tasks' -Method POST -Headers $headers -ContentType 'application/deploymentTaskDetails.v1+json' -Body '{"taskDescription":"","taskName":"DeploymentTask6","templateID":1}'

Sample Request Body

Create a deployment task with only the mandatory fields

Copied!

  {
    "taskDescription": "",
    "taskName": "DeploymentTask6",
    "templateID": 1
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/deploymentTaskCreatedStatus.v1+json

JSON Object

Hide Sub-Attributes

isTaskCreatedboolean

True if the task was successfully created.

isTaskCommittedboolean

False immediately after creation. Becomes true once the task is committed via PUT /tasks/{taskId}. Starting the task is a separate subsequent step.

taskIDlong

ID of the newly created deployment task.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Task created successfully

Copied!

  {
    "isTaskCommitted": false,
    "isTaskCreated": true,
    "taskID": 200
  }

▼ Show full

Duration: 1 minute | Threshold: 50 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.