API Docs - For Review
/
No Results Found

Upload Entities

The Upload Entities API can be used to upload entities for a specific action.
OAuth Scope : id360.management.write,id360.management.create,id360.management.all

Arguments

file
binary
File to be uploaded for the action

Query Parameters

app_config_id
The ID of the app configuration to be used for the action

Request Example

Click to copy
parameters_data = Map(); parameters_data.put("field1", "value1") parameters_data.put("field2", "value2") headers_data = Map(); headers_data.put("Accept", "application/json"); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://id360.manageengine.com/api/v1/management/actions/move-users/uploads" type: POST headers: headers_data parameters: parameters_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001"); RequestBody body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field1\"\r\n\r\nvalue1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field2\"\r\n\r\nvalue2\r\n-----011000010111000001101001--\r\n"); Request request = new Request.Builder() .url("https://id360.manageengine.com/api/v1/management/actions/move-users/uploads") .post(body) .addHeader("Accept", "application/json") .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .addHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001") .build(); Response response = client.newCall(request).execute();
const form = new FormData(); form.append("field1", "value1"); form.append("field2", "value2"); const options = { method: 'POST', headers: { Accept: 'application/json', Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f', 'content-type': 'multipart/form-data; boundary=---011000010111000001101001' } }; options.body = form; fetch('https://id360.manageengine.com/api/v1/management/actions/move-users/uploads', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("id360.manageengine.com") payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field1\"\r\n\r\nvalue1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field2\"\r\n\r\nvalue2\r\n-----011000010111000001101001--\r\n" headers = { 'Accept': "application/json", 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", 'content-type': "multipart/form-data; boundary=---011000010111000001101001" } conn.request("POST", "/api/v1/management/actions/move-users/uploads", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "POST", "hostname": "id360.manageengine.com", "port": null, "path": "/api/v1/management/actions/move-users/uploads", "headers": { "Accept": "application/json", "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", "content-type": "multipart/form-data; boundary=---011000010111000001101001" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field1\"\r\n\r\nvalue1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field2\"\r\n\r\nvalue2\r\n-----011000010111000001101001--\r\n"); req.end();
curl --request POST \ --url https://id360.manageengine.com/api/v1/management/actions/move-users/uploads \ --header 'Accept: application/json' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'content-type: multipart/form-data' \ --form field1=value1 \ --form field2=value2

Body Parameters

Click to copy
{ "file": "-----BEGIN FILE-----\n(binary file data: users_upload.csv)\nContent-Type: text/csv\nid,first_name,last_name,email\n1,John,Doe,john.doe@example.com\n2,Jane,Smith,jane.smith@example.com\n-----END FILE-----" }

Response Example

{ "data": { "id": 2000000000001, "header": [ { "name": "first_name", "is_match_column": true }, { "name": "last_name", "is_match_column": true }, { "name": "email", "is_match_column": true }, { "name": "employee_id", "is_match_column": false } ], "match_columns": [ "email", "first_name", "last_name" ] } }
{ "error": { "code": "00000101", "title": "Unauthorized", "detail": "The OAuth token is invalid." } }
{ "error": { "code": "00000000", "title": "Internal Server Error", "detail": "An unexpected internal error has occurred on the server. Please try again later." } }

Get Upload Details

The Get Upload Details API can be used to get the details of a specific upload for an action.
OAuth Scope : id360.management.read,id360.management.all

Request Example

Click to copy
headers_data = Map(); headers_data.put("Accept", "application/json"); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001" type: GET headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001") .get() .addHeader("Accept", "application/json") .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'GET', headers: { Accept: 'application/json', Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("id360.manageengine.com") headers = { 'Accept': "application/json", 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/api/v1/management/actions/move-users/uploads/2000000000001", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "GET", "hostname": "id360.manageengine.com", "port": null, "path": "/api/v1/management/actions/move-users/uploads/2000000000001", "headers": { "Accept": "application/json", "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
curl --request GET \ --url https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001 \ --header 'Accept: application/json' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "data": { "id": 2000000000001, "header": [ { "name": "first_name", "is_match_column": true }, { "name": "last_name", "is_match_column": true }, { "name": "email", "is_match_column": true }, { "name": "employee_id", "is_match_column": false } ], "match_columns": [ "email", "first_name", "last_name" ] } }
{ "error": { "code": "00000101", "title": "Unauthorized", "detail": "The OAuth token is invalid." } }
{ "error": { "code": "00000000", "title": "Internal Server Error", "detail": "An unexpected internal error has occurred on the server. Please try again later." } }

Get Uploaded Entities

The Get Upload Action Data API can be used to upload data for a specific action.
OAuth Scope : id360.management.read,id360.management.all

Query Parameters

from
The starting index for pagination. Default is 0.
limit
Limit the number of records to be fetched
filter
Filter data based on a the provided SCIM filter query. Refer to filter section for more details
eg: first_name eq "John" and last_name eq "Doe"
app_config_id
The ID of the app configuration to be used for the action

Request Example

Click to copy
headers_data = Map(); headers_data.put("Accept", "application/json"); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001/data" type: GET headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001/data") .get() .addHeader("Accept", "application/json") .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'GET', headers: { Accept: 'application/json', Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001/data', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("id360.manageengine.com") headers = { 'Accept': "application/json", 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/api/v1/management/actions/move-users/uploads/2000000000001/data", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "GET", "hostname": "id360.manageengine.com", "port": null, "path": "/api/v1/management/actions/move-users/uploads/2000000000001/data", "headers": { "Accept": "application/json", "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
curl --request GET \ --url https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001/data \ --header 'Accept: application/json' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "data": [ { "id": "2000000110001", "user_id": "200000010001", "status": "MAPPED", "imported_data": { "header1": "value1", "header2": "value2" } }, { "id": "2000000110002", "user_id": "200000010002", "status": "DUPLICATE_USER", "imported_data": { "header1": "value3", "header2": "value4" } } ], "meta": { "start_index": "1", "limit": 200, "total_no_of_objects": 2 } }
{ "error": { "code": "00000101", "title": "Unauthorized", "detail": "The OAuth token is invalid." } }
{ "error": { "code": "00000000", "title": "Internal Server Error", "detail": "An unexpected internal error has occurred on the server. Please try again later." } }

Delete Upload Entities

The Delete Upload Entities API can be used to delete entities from the uploaded data for a specific action.
OAuth Scope : id360.management.write,id360.management.delete,id360.management.all

Query Parameters

ids
(Required)
Comma-separated list of IDs to be deleted
filter
Filter data based on a the provided SCIM filter query. Refer to filter section for more details
eg: first_name eq "John" and last_name eq "Doe"

Request Example

Click to copy
headers_data = Map(); headers_data.put("Accept", "application/json"); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001/data?ids=2000000000001,2000000000002" type: DELETE headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001/data?ids=2000000000001%2C2000000000002") .delete(null) .addHeader("Accept", "application/json") .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'DELETE', headers: { Accept: 'application/json', Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001/data?ids=2000000000001%2C2000000000002', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("id360.manageengine.com") headers = { 'Accept': "application/json", 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("DELETE", "/api/v1/management/actions/move-users/uploads/2000000000001/data?ids=2000000000001%2C2000000000002", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "DELETE", "hostname": "id360.manageengine.com", "port": null, "path": "/api/v1/management/actions/move-users/uploads/2000000000001/data?ids=2000000000001%2C2000000000002", "headers": { "Accept": "application/json", "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
curl --request DELETE \ --url 'https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001/data?ids=2000000000001%2C2000000000002' \ --header 'Accept: application/json' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "error": { "code": "00000101", "title": "Unauthorized", "detail": "The OAuth token is invalid." } }
{ "error": { "code": "00000000", "title": "Internal Server Error", "detail": "An unexpected internal error has occurred on the server. Please try again later." } }

Delete Upload Entity

The Delete Upload Entity API can be used to delete a specific entity from the uploaded data for a specific action.
OAuth Scope : id360.management.write,id360.management.delete,id360.management.all

Request Example

Click to copy
headers_data = Map(); headers_data.put("Accept", "application/json"); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001/data/2000000000001" type: DELETE headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001/data/2000000000001") .delete(null) .addHeader("Accept", "application/json") .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'DELETE', headers: { Accept: 'application/json', Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001/data/2000000000001', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("id360.manageengine.com") headers = { 'Accept': "application/json", 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("DELETE", "/api/v1/management/actions/move-users/uploads/2000000000001/data/2000000000001", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "DELETE", "hostname": "id360.manageengine.com", "port": null, "path": "/api/v1/management/actions/move-users/uploads/2000000000001/data/2000000000001", "headers": { "Accept": "application/json", "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
curl --request DELETE \ --url https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001/data/2000000000001 \ --header 'Accept: application/json' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "error": { "code": "00000101", "title": "Unauthorized", "detail": "The OAuth token is invalid." } }
{ "error": { "code": "00000000", "title": "Internal Server Error", "detail": "An unexpected internal error has occurred on the server. Please try again later." } }

Update Upload Match Columns

The Update Upload Match Columns API can be used to update the match columns for a specific action upload.
OAuth Scope : id360.management.read,id360.management.all

Query Parameters

app_config_id
The ID of the app configuration to be used for the action

Request Example

Click to copy
parameters_data='{"field1":"value1","field2":"value2"}'; headers_data = Map(); headers_data.put("Accept", "application/json"); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001/match-columns" type: PUT headers: headers_data content-type: application/json parameters: parameters_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}"); Request request = new Request.Builder() .url("https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001/match-columns") .put(body) .addHeader("Accept", "application/json") .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .addHeader("content-type", "application/json") .build(); Response response = client.newCall(request).execute();
const options = { method: 'PUT', headers: { Accept: 'application/json', Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f', 'content-type': 'application/json' }, body: '{"field1":"value1","field2":"value2"}' }; fetch('https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001/match-columns', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("id360.manageengine.com") payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}" headers = { 'Accept': "application/json", 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", 'content-type': "application/json" } conn.request("PUT", "/api/v1/management/actions/move-users/uploads/2000000000001/match-columns", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "PUT", "hostname": "id360.manageengine.com", "port": null, "path": "/api/v1/management/actions/move-users/uploads/2000000000001/match-columns", "headers": { "Accept": "application/json", "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", "content-type": "application/json" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({field1: 'value1', field2: 'value2'})); req.end();
curl --request PUT \ --url https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001/match-columns \ --header 'Accept: application/json' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'content-type: application/json' \ --data '{"field1":"value1","field2":"value2"}'

Body Parameters

Click to copy
[ "email", "last_name", "employee_id" ]

Response Example

{ "data": [ "email", "last_name", "employee_id" ] }
{ "error": { "code": "00000101", "title": "Unauthorized", "detail": "The OAuth token is invalid." } }
{ "error": { "code": "00000000", "title": "Internal Server Error", "detail": "An unexpected internal error has occurred on the server. Please try again later." } }

Execute Upload

The Execute Upload API can be used to execute a specific action with the provided upload.
OAuth Scope : id360.management.write,id360.management.all

Arguments

app_config_id
string
The ID of the app configuration to be used for the action
template_input
object
Input data of the template to be used for the action execution.
Show Sub-Attributes arrow
id
string
The ID of the template to be used for the action execution.
data
array
Show Sub-Attributes arrow
OPERATION
string
The operation to be performed on the entities for enable or disable action.
user_ids
array
List of user IDs to be included in the action execution.

Request Example

Click to copy
parameters_data='{"field1":"value1","field2":"value2"}'; headers_data = Map(); headers_data.put("Accept", "application/json"); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001/execute" type: POST headers: headers_data content-type: application/json parameters: parameters_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}"); Request request = new Request.Builder() .url("https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001/execute") .post(body) .addHeader("Accept", "application/json") .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .addHeader("content-type", "application/json") .build(); Response response = client.newCall(request).execute();
const options = { method: 'POST', headers: { Accept: 'application/json', Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f', 'content-type': 'application/json' }, body: '{"field1":"value1","field2":"value2"}' }; fetch('https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001/execute', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("id360.manageengine.com") payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}" headers = { 'Accept': "application/json", 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", 'content-type': "application/json" } conn.request("POST", "/api/v1/management/actions/move-users/uploads/2000000000001/execute", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "POST", "hostname": "id360.manageengine.com", "port": null, "path": "/api/v1/management/actions/move-users/uploads/2000000000001/execute", "headers": { "Accept": "application/json", "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", "content-type": "application/json" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({field1: 'value1', field2: 'value2'})); req.end();
curl --request POST \ --url https://id360.manageengine.com/api/v1/management/actions/move-users/uploads/2000000000001/execute \ --header 'Accept: application/json' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'content-type: application/json' \ --data '{"field1":"value1","field2":"value2"}'

Body Parameters

Click to copy
{ "app_config_id": 2000000000001, "template_input": { "id": 2000000000001, "data": [ { "OPERATION": "DISABLE" } ] }, "user_ids": [ "2000000174051", "2000000174052", "2000000174053" ] }

Response Example

{ "data": { "id": 2000000000001, "status": "yet_to_start" } }
{ "error": { "code": "00000101", "title": "Unauthorized", "detail": "The OAuth token is invalid." } }
{ "error": { "code": "00000000", "title": "Internal Server Error", "detail": "An unexpected internal error has occurred on the server. Please try again later." } }