Операции с пользователями · ServiceDesk Plus

Выполнение операции Get All (для версий начиная со сборки 11000)

Используйте следующий формат URL

<protocol>://<hostname>:<port number>/api/v3/users

Пример выходных данных

{
"response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
],
"list_info": {
    "has_more_rows": false,
    "sort_field": "name",
    "start_index": 1,
    "sort_order": "asc",
    "row_count": 7
},
"users": [
    {
      "email_id": "guest@zoho.com",
      "purchase_approver": true,
      "ci_people_fields": {},
      "description": "End User of the software product",
      "is_vipuser": false,
      "reporting_to": {
        "email_id": null,
        "name": "administrator",
        "is_vipuser": false,
        "id": "4",
        "department": null
      },
      "type": "User",
      "citype": {
        "name": "User",
        "id": 3
      },
      "cost_per_hour": "500.00",
      "ci_default_fields": {
        "udf_pickref_1": {
          "name": "High",
          "id": 1
        },
        "udf_pick_165": "Team member",
        "udf_sline_164": null
      },
      "org_user_status": "ACTIVE",
      "id": "3",
      "department": {
        "site": null,
        "name": "Administration",
        "id": "1"
      },
      "first_name": null,
      "profile_pic_url": null,
      "service_request_approver": true,
      "created_time": {
        "display_value": "Sep 6, 2019 05:30 AM",
        "value": "1567728017353"
      },
      "is_technician": false,
      "jobtitle": null,
      "mobile": "1234567890",
      "project_roles": {
        "name": "Project Manager",
        "id": "3"
      },
      "last_name": null,
      "sms_mail_id": null,
      "middle_name": null,
      "ciid": "17",
      "purchase_approval_limit": "1000.00",
      "login_name": "guest",
      "phone": "8888",
      "employee_id": "888",
      "domain": {
        "name": "WORKGROUP",
        "id": "1"
      },
      "name": "Guest",
      "ci_user_fields": {
        "udf_pickref_160": null,
        "udf_pickref_161": {
          "name": "administrator",
          "id": 4
        },
        "udf_sline_158": "Software analyst",
        "udf_pickref_159": {
          "site": null,
          "name": "Engineering",
          "id": 2
        },
        "udf_pick_163": "5 th floor",
        "udf_sline_162": "12LE35"
      },
      "user_udf_fields": {
        "udf_pick_2": "support",
        "udf_long_3": "9823881",
        "udf_sline_1": "Active",
        "udf_date_4": {
          "display_value": "Sep 25, 2019 10:53 PM",
          "value": "1569432180000"
        }
      },
      "status": "ACTIVE",
      "requester_allowed_to_view": null
    },
    {
      "email_id": "heather@gmail.com",
      "purchase_approver": false,
      "ci_people_fields": {},
      "description": "Help Desk Executive",
      "is_vipuser": false,
      "reporting_to": {
        "email_id": null,
        "name": "administrator",
        "is_vipuser": false,
        "id": "4",
        "department": null
      },
      "type": "Technician",
      "citype": {
        "name": "User",
        "id": 3
      },
      "cost_per_hour": "12.00",
      "ci_default_fields": {
        "udf_pickref_1": {
          "name": "Medium",
          "id": 2
        },
        "udf_pick_165": "Project Manager",
        "udf_sline_164": "IT Help Desk"
      },
      "org_user_status": "ACTIVE",
      "id": "6",
      "department": {
        "site": null,
        "name": "IT Services",
        "id": "5"
      },
      "first_name": null,
      "profile_pic_url": null,
      "service_request_approver": null,
      "created_time": {
        "display_value": "Sep 6, 2019 05:30 AM",
        "value": "1567728017353"
      },
      "is_technician": true,
      "jobtitle": null,
      "mobile": "92891",
      "project_roles": {
        "name": "Project Manager",
        "id": "3"
      },
      "last_name": null,
      "sms_mail_id": "help@sms.com",
      "middle_name": null,
      "ciid": "20",
      "purchase_approval_limit": "-1.00",
      "login_name": "heather",
      "phone": "925",
      "employee_id": "011",
      "domain": {
        "name": "ZOHOCORP",
        "id": "2"
      },
      "name": "Heather Graham",
      "ci_user_fields": {
        "udf_pickref_160": null,
        "udf_pickref_161": {
          "name": "administrator",
          "id": 4
        },
        "udf_sline_158": "Testing manager",
        "udf_pickref_159": {
          "site": null,
          "name": "Finance",
          "id": 4
        },
        "udf_pick_163": "Ground Floor",
        "udf_sline_162": "5FD92"
      },
      "user_udf_fields": {
        "udf_pick_2": "support",
        "udf_long_3": "9289",
        "udf_sline_1": "Help Desk Executive",
        "udf_date_4": {
          "display_value": "Sep 9, 2019 10:55 PM",
          "value": "1568049900000"
        }
      },
      "status": "ACTIVE"
    }
]
}

Выполнение Get All с критериями и требуемыми полями (версии после 11000)

Используйте следующий формат URL:

<protocol>://<hostname>:<port number>/api/v3/users

Пример входных данных

{
"list_info": {
    "sort_field": "name",
    "start_index": 1,
    "sort_order": "asc",
    "row_count": "25",
    "get_total_count": true,
    "search_fields": {
      "email_id": "guest@zoho.com"
    }
},
"fields_required": [
    "name",
    "is_technician",
    "citype",
    "login_name",
    "email_id",
    "department",
    "phone",
    "mobile",
    "jobtitle",
    "project_roles",
    "employee_id",
    "first_name",
    "middle_name",
    "last_name",
    "is_vipuser",
    "ciid"
]
}

Пример выходных данных

{
"list_info": {
    "sort_field": "name",
    "start_index": 1,
    "sort_order": "asc",
    "row_count": 1,
    "get_total_count": "true",
    "search_fields": {
      "email_id": "guest@zoho.com"
    },
    "has_more_rows": false,
    "total_count": 1
},
"response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
],
"users": [
    {
      "email_id": "guest@zoho.com",
      "is_technician": false,
      "jobtitle": null,
      "ci_people_fields": {},
      "mobile": "1234567890",
      "project_roles": {
        "name": "Project Manager",
        "id": "3"
      },
      "last_name": null,
      "is_vipuser": false,
      "middle_name": null,
      "type": "User",
      "citype": {
        "name": "User",
        "id": 3
      },
      "ciid": "17",
      "ci_default_fields": {
        "udf_pickref_1": {
          "name": "High",
          "id": 1
        },
        "udf_pick_165": "Team member",
        "udf_sline_164": null
      },
      "login_name": "guest",
      "phone": "8888",
      "employee_id": "888",
      "name": "Guest",
      "ci_user_fields": {
        "udf_pickref_160": null,
        "udf_pickref_161": {
          "name": "administrator",
          "id": 4
        },
        "udf_sline_158": "Software analyst",
        "udf_pickref_159": {
          "site": null,
          "name": "Engineering",
          "id": 2
        },
        "udf_pick_163": "5 th floor",
        "udf_sline_162": "1E35"
      },
      "id": "3",
      "department": {
        "site": null,
        "name": "Administration",
        "id": "1"
      },
      "first_name": null
    }
]
}

Для старых версий до 11000

Чтобы получить сведения обо всех заявителях, используйте следующий формат URL:

http://<servername>:<port number>/sdpapi/requester/

Пример:

http://localhost:8080/sdpapi/requester/

Получение всех заявителей

Основные моменты:

Имя операции "GET_ALL" необходимо передать как атрибут POST с ключом "OPERATION_NAME".
Входные значения учитывают регистр.
Если указано несколько параметров, применяется операция AND.
Для параметра контактного номера возвращаются все номера заявителя: рабочий и мобильный.
Результат определяется точным указанным значением. Например, при поиске заявителя John заявитель Johnathan не будет найден. Чтобы найти и его, добавьте "*" после John. Например: <value>john*</value>. Аналогичное правило действует и для префикса.

Примечание: форматы входного и выходного XML изменены. Для совместимости операция ввода поддерживает оба формата.

Формат входных данных

<name>loginname</name>

<value>guest</value>

</parameter>

<name>domainname</name>

</parameter>

<name>department</name>

<value>administration</value>

</parameter>

<name>sitename</name>

</parameter>

<name>contactnumber</name>

</parameter>

<name>employeeid</name>

</parameter>

<value>GUEST</value>

</parameter>

<name>email</name>

</parameter>

<name>jobtitle</name>

<value>job title</value>

</parameter>

<name>noofrows</name>

</parameter>

</Details>

</Operation>

Формат выходных данных

<name>userid</name>

</parameter>

<name>username</name>

<value>guest</value>

</parameter>

<name>emailid</name>

</parameter>

<name>department</name>

<value>Administration</value>

</parameter>

<name>sitename</name>

</parameter>

<name>domainname</name>

</parameter>

<name>employeeid</name>

</parameter>

<name>jobtitle</name>

<value>job title</value>

</parameter>

<name>landline</name>

</parameter>

<name>mobile</name>

</parameter>

</Details>

</Operation>