Job

Job APIs for ID360

Download Job OpenAPI Document

End Points

GET

Attribute

string

Unique identifier for the job

start_time

date-time

Start time of the job in ISO 8601 format

end_time

date-time

End time of the job in ISO 8601 format

action_name

string

Name of the action performed by the job

status

string

Status of the job.

Allowed Values:

QUEUED
RUNNING
WARNING
COMPLETED
ERROR

module

string

Module associated with the job

details

object

Details of the job.
Note: This field is module-specific and may vary based on the job type.

Show Sub-Attributes

entity

string

Entity associated with the job

result

array

Show Sub-Attributes

string

Unique identifier for the entity

status

string

Status of the operation on the entity

message

string

Message describing the result of the operation

{
    "id": "2000000000001",
    "start_time": "2025-04-04T13:12:13.000Z",
    "end_time": "2025-04-04T13:12:16.000Z",
    "action_name": "Bulk User Creation",
    "status": "COMPLETED",
    "module": "Management",
    "details": {
        "entity": "User",
        "result": [
            {
                "id": "2000000000011",
                "status": "SUCCESS",
                "message": "User created successfully"
            },
            {
                "id": "2000000000012",
                "status": "ERROR",
                "message": "Email already exists"
            }
        ]
    }
}

Get Jobs

The Get Jobs API can be used to retrieve a list of jobs.
OAuth Scope : id360.job.ALL,id360.job.READ

Query Parameters

limit

Number of user creation templates to be returned in the response

from

Start range of the response

filter

Filter users based on a the provided SCIM filter query. Refer to filter section for more details
eg: module eq "Management" and status eq "COMPLETED"

Request Example

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/jobs"
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/jobs")
  .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/jobs', 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/jobs", 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/jobs",
  "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/jobs \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "data": [
        {
            "id": "2000000000001",
            "start_time": "2025-04-04T13:12:13.000Z",
            "end_time": "2025-04-04T13:12:16.000Z",
            "action_name": "Single User Creation",
            "status": "COMPLETED",
            "module": "Management"
        },
        {
            "id": "2000000000002",
            "start_time": "2025-04-04T13:14:21.000Z",
            "end_time": "2025-04-04T13:14:24.000Z",
            "action_name": "Bulk User Creation",
            "status": "ERROR",
            "module": "Management"
        },
        {
            "id": "2000000000003",
            "start_time": "2025-04-04T13:15:13.000Z",
            "end_time": "2025-04-04T13:15:16.000Z",
            "action_name": "Single User Creation",
            "status": "WARNING",
            "module": "Management"
        },
        {
            "id": "2000000000004",
            "start_time": "2025-04-04T13:16:13.000Z",
            "end_time": null,
            "action_name": "Bulk User Creation",
            "status": "RUNNING",
            "module": "Management"
        },
        {
            "id": "2000000000005",
            "start_time": "2025-04-04T13:18:13.000Z",
            "end_time": null,
            "action_name": "Bulk User Creation",
            "status": "QUEUED",
            "module": "Management"
        }
    ],
    "meta": {
        "start_index": "1",
        "limit": 200,
        "total_no_of_objects": 5
    }
}

{
    "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 Job by ID

The Get Job by ID API can be used to retrieve a specific job by its ID.
OAuth Scope : id360.job.ALL,id360.job.READ

Request Example

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/jobs/987000000654321"
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/jobs/987000000654321")
  .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/jobs/987000000654321', 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/jobs/987000000654321", 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/jobs/987000000654321",
  "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/jobs/987000000654321 \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "id": "2000000000001",
    "start_time": "2025-04-04T13:12:13.000Z",
    "end_time": "2025-04-04T13:12:16.000Z",
    "action_name": "Bulk User Creation",
    "status": "COMPLETED",
    "module": "Management",
    "details": {
        "entity": "User",
        "result": [
            {
                "id": "2000000000011",
                "status": "SUCCESS",
                "message": "User created successfully"
            },
            {
                "id": "2000000000012",
                "status": "ERROR",
                "message": "Email already exists"
            }
        ]
    }
}

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "----",
        "title": "Job Not Found",
        "detail": "The requested job does not exist or has been deleted."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}

Delete Job by ID

The Delete Job by ID API can be used to delete a specific job by its ID.
OAuth Scope : id360.job.ALL,id360.job.DELETE

Request Example

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/jobs/987000000654321"
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/jobs/987000000654321")
  .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/jobs/987000000654321', 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/jobs/987000000654321", 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/jobs/987000000654321",
  "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/jobs/987000000654321 \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "----",
        "title": "Job Not Found",
        "detail": "The requested job does not exist or has been deleted."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}