Просмотреть исходный

Описание : Список рабочих станций

Метод: GET

Ресурс: workstation

Параметры:

filter — список фильтрации:
- change_date[from] — от даты последнего изменения в формате UNIX-timestamp (можно использовать отдельно от change_date[to])
- change_date[to] — до даты последнего изменения в формате UNIX-timestamp (можно использовать отдельно от change_date[from])
- create_date[from] — от даты создания в формате UNIX-timestamp (можно использовать отдельно от create_date[to])
- create_date[to] — до даты создания в формате UNIX-timestamp (можно использовать отдельно от create_date[from]
- is_deleted — флаг 1 или 0. Если параметр указан, то будут выдавать сущности с указанным значением
- disabled — флаг 1 или 0, признак активности. Если выставлен, то сущность неактивна (признак берется из LDAP)
- contact_type[] — фильтрация по типу контакта (можно передать несколько, например: /xapi/workstation?filter[contact_type][]=webaccount&filter[contact_type][]=icq)
- contact_value[] — фильтрация по значению контакта (можно передавать несколько, например: /xapi/workstation?filter[contact_value][]=user@ad&filter[contact_value][]=login@example.com)
- group_id[] — фильтрация по группам (можно передать несколько, например: /xapi/workstation?filter[group_id][]=FCE1409680E5D6469E1F7998266CE9E9&filter[group_id][]=918462B6DC2C954BAAF8706F7DC53F14)
with[] — список дополнительных сущностей, которые должны быть добавлены к объекту:
- contacts — контакты рабочей станции
- w2g — связь рабочей станции с группами
- status — статусы рабочей станции
sort — параметр для сортировки
- change_date — сортировать по дате изменения asc или desc (например: /xapi/workstation?sort[change_date]=asc) может замедлить выдачу

start — с какой позиции начать отдавать элементы, по-умолчанию 0
limit — сколько элементов отдавать, по-умолчанию 100, не может быть больше 1000

Ответ : Список рабочих старнций, описанный следующей JSON-Schema :

JSON схема отдачи

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "required": [
        "data",
        "meta"
    ],
    "properties": {
        "data": {
            "description": "Массив Рабочих станций",
            "type": "array",
            "items": {
                "description": "Рабочая станция",
                "type": "object",
                "required": [
                    "WORKSTATION_ID",
                    "CREATE_DATE",
                    "CHANGE_DATE",
                    "DISPLAY_NAME",
                    "DISTINGUISHEDNAME",
                    "DNSHOSTNAME",
                    "DISABLED",
                    "TYPE",
                    "IS_DELETED"
                ],
                "properties": {
                    "WORKSTATION_ID": {
                        "description": "Уникальный идентификатор рабочей станции",
                        "type": "string"
                    },
                    "CREATE_DATE": {
                        "description": "Дата создания записи",
                        "type": "string"
                    },
                    "CHANGE_DATE": {
                        "description": "Дата изменения записи",
                        "type": "string"
                    },
                    "DISPLAY_NAME": {
                        "description": "Название рабочей станции",
                        "type": "string"
                    },
                    "DISTINGUISHEDNAME": {
                        "description": "Отличительное имя",
                        "type": "string"
                    },
                    "DNSHOSTNAME": {
                        "description": "Полное имя",
                        "type": "string"
                    },
                    "DISABLED": {
                        "description": "Состояние рабочей станции",
                        "type": "integer"
                    },
                    "TYPE": {
                        "description": "Тип: computer — Рабочая станция, mobile — Мобильное устройство, terminal — Терминальный сервер",
                        "type": "string"
                    },
                    "IS_DELETED": {
                        "description": "Удалена ли рабочая станция из TM",
                        "type": "integer"
                    },
                    "contacts": {
                        "description": "Массив контактов",
                        "type": "array",
                        "items": {
                            "description": "Контакт",
                            "type": "object",
                            "required": [
                                "CONTACT_ID",
                                "CREATE_DATE",
                                "CHANGE_DATE",
                                "CONTACT_TYPE",
                                "VALUE",
                                "IS_PERSONAL",
                                "IS_PRIMARY",
                                "SOURCE"
                            ],
                            "properties": {
                                "CONTACT_ID": {
                                    "description": "Уникальный идентификатор объекта",
                                    "type": "string"
                                },
                                "CREATE_DATE": {
                                    "description": "Дата создания",
                                    "type": "string"
                                },
                                "CHANGE_DATE": {
                                    "description": "Дата изменения",
                                    "type": "string"
                                },
                                "CONTACT_TYPE": {
                                    "description": "Тип",
                                    "type": "string"
                                },
                                "VALUE": {
                                    "description": "Значение",
                                    "type": "string"
                                },
                                "IS_PERSONAL": {
                                    "description": "Принадлежность (Рабочий, Личный)",
                                    "type": "integer"
                                },
                                "IS_PRIMARY": {
                                    "description": "Признак основной",
                                    "type": "integer"
                                },
                                "SOURCE": {
                                    "description": "Тип",
                                    "type": "string"
                                }
                            }
                        }
                    },
                    "w2g": {
                        "description": "Массив связи с группами",
                        "type": "array",
                        "items": {
                            "description": "Связь с группой",
                            "type": "object",
                            "required": [
                                "WORKSTATION_ID",
                                "PARENT_GROUP_ID",
                                "RELATION_TYPE"
                            ],
                            "properties": {
                                "WORKSTATION_ID": {
                                    "description": "Уникальный идентификатор рабочей станции",
                                    "type": "string"
                                },
                                "PARENT_GROUP_ID": {
                                    "description": "Уникальный идентификатор группы",
                                    "type": "string"
                                },
                                "RELATION_TYPE": {
                                    "description": "Тип связи: 0 - tm, 1 - member, 2 - distinguishedname, 3 - primarygroupsid",
                                    "type": "integer"
                                }
                            }
                        }
                    },
                    "status": {
                        "description": "Массив статусов",
                        "type": "array",
                        "items": {
                            "description": "Статус персоны",
                            "type": "object",
                            "required": [
                                "IDENTITY_STATUS_ID",
                                "CREATE_DATE",
                                "CHANGE_DATE",
                                "ASSIGNMENT_DATE",
                                "DISPLAY_NAME",
                                "COLOR",
                                "EDITABLE"
                            ],
                            "properties": {
                                "IDENTITY_STATUS_ID": {
                                    "description": "Уникальный идентификатор статуса",
                                    "type": "string"
                                },
                                "CREATE_DATE": {
                                    "description": "Дата создания статуса",
                                    "type": "string"
                                },
                                "CHANGE_DATE": {
                                    "description": "Дата изменения статуса",
                                    "type": "string"
                                },
                                "ASSIGNMENT_DATE": {
                                    "description": "Дата проставления статуса персоне",
                                    "type": "string"
                                },
                                "DISPLAY_NAME": {
                                    "description": "Название статуса",
                                    "type": "string"
                                },
                                "COLOR": {
                                    "description": "Цвет статуса (например #ff0000)",
                                    "type": "string"
                                },
                                "EDITABLE": {
                                    "description": "Признак, что статус не является системным",
                                    "type": "integer"
                                }
                            }
                        }
                    }
                }
            }
        },
        "meta": {
            "description": "Дополнительные данные",
            "type": "object",
            "required": [
                "totalCount",
                "start",
                "limit"
            ],
            "properties": {
                "totalCount": {
                    "type": "integer",
                    "description": "Общее количество"
                },
                "start": {
                    "type": "integer",
                    "description": "С какой позиции началось отдаваться"
                },
                "limit": {
                    "type": "integer",
                    "description": "Сколько всего отдалось"
                }
            }
        }
    }
}

Пример:

Запрос

/xapi/workstation?filter[change_date][from]=1&filter[change_date][to]=2&with[]=contacts&with[]=w2g&limit=10&sort[change_date]=asc