[Index]
HcsMoveFilterDAT
Model ref.: data/HcsMoveFilterDAT
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"preferred_language_filter": {
"is_password": false,
"description": "A filter based on matching against the user's preferred language.",
"title": "Preferred Language Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's preferred language.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's preferred language.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"given_name_filter": {
"is_password": false,
"description": "A filter based on matching against the user's first name.",
"title": "First Name Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's first name.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's first name.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"directory_uri_filter": {
"is_password": false,
"description": "A filter based on matching against the user's directory URI.",
"title": "Directory URI Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's directory URI.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's directory URI.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"ou_filter": {
"is_password": false,
"description": "A filter based on matching against the user's organization unit name.",
"title": "Organization Unit Name Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's organization unit name.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's organization unit name.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"st_filter": {
"is_password": false,
"description": "A filter based on matching against the user's state.",
"title": "State Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's state.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's state.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"custom_list_of_strings_4_filter": {
"is_password": false,
"description": "A filter based on matching against the user's custom list of strings 4.",
"title": "Custom List of Strings 4 Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's custom list of strings 4.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's custom list of strings 4.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"c_filter": {
"is_password": false,
"description": "A filter based on matching against the user's country.",
"title": "Country Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's country.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's country.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"uid_filter": {
"is_password": false,
"description": "A filter based on matching against the user's uid.",
"title": "Uid Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's uid.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's uid.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"username_filter": {
"is_password": false,
"description": "A filter based on matching against the user's username.",
"title": "Username Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's username.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's username.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"mail_filter": {
"is_password": false,
"description": "A filter based on matching against the user's mail.",
"title": "Mail Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's mail.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's mail.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"custom_list_of_strings_3_filter": {
"is_password": false,
"description": "A filter based on matching against the user's custom list of strings 3.",
"title": "Custom List of Strings 3 Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's custom list of strings 3.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's custom list of strings 3.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"manager_filter": {
"is_password": false,
"description": "A filter based on matching against the user's manager.",
"title": "Manager Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's manager.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's manager.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"street_filter": {
"is_password": false,
"description": "A filter based on matching against the user's street.",
"title": "Street Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's street.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's street.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"custom_list_of_strings_1_filter": {
"is_password": false,
"description": "A filter based on matching against the user's custom list of strings 1.",
"title": "Custom List of Strings 1 Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's custom list of strings 1.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's custom list of strings 1.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"custom_string_4_filter": {
"is_password": false,
"description": "A filter based on matching against the user's custom string 4.",
"title": "Custom String 4 Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's custom string 4.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's custom string 4.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"employee_number_filter": {
"is_password": false,
"description": "A filter based on matching against the user's employee number.",
"title": "Employee Number Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's employee number.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's employee number.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"display_name_filter": {
"is_password": false,
"description": "A filter based on matching against the user's display name.",
"title": "Display Name Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's display name.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's display name.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"jabber_id_filter": {
"is_password": false,
"description": "A filter based on matching against the user's Jabber ID.",
"title": "Jabber ID Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's Jabber ID.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's Jabber ID.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"custom_string_3_filter": {
"is_password": false,
"description": "A filter based on matching against the user's custom string 3.",
"title": "Custom String 3 Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's custom string 3.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's custom string 3.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"custom_string_1_filter": {
"is_password": false,
"description": "A filter based on matching against the user's custom string 1.",
"title": "Custom String 1 Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's custom string 1.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's custom string 1.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"member_of_filter": {
"is_password": false,
"description": "A filter based on matching against the user's member of.",
"title": "Member Of Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's member of.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's groups.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"telephone_number_filter": {
"is_password": false,
"description": "A filter based on matching against the user's telephone number.",
"title": "Telephone Number Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's telephone number.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's telephone number.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"custom_list_of_strings_5_filter": {
"is_password": false,
"description": "A filter based on matching against the user's custom list of strings 5.",
"title": "Custom List of Strings 5 Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's custom list of strings 5.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's custom list of strings 5.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"employee_type_filter": {
"is_password": false,
"description": "A filter based on matching against the user's employee type.",
"title": "Employee Type Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's employee type.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's employee type.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"dept_filter": {
"is_password": false,
"description": "A filter based on matching against the user's department number.",
"title": "Department Number Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's department number.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's department number.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"move_to_hn_uri": {
"is_password": false,
"description": "The business key of the hierarchy node to which the user will be moved if the conditions are satisfied.",
"format": "uri",
"title": "Move To Hierarchy ",
"required": true,
"displayable": false,
"choices": [],
"readonly": false,
"maxLength": 1024,
"target_model_type": "data/HierarchyNode",
"type": "string",
"target": "/api/data/HierarchyNode/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"unverified_mail_box_filter": {
"is_password": false,
"description": "A filter based on matching against the user's unverified mail box.",
"title": "Unverified Mail Box Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's unverified mail box.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's unverified mail box.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"o_filter": {
"is_password": false,
"description": "A filter based on matching against the user's organization name.",
"title": "Organization Name Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's organization name.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's organization name.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"move_to_role": {
"is_password": false,
"description": "The default role to assign to the moved user (if no other LDAP Custom Role Mappings are applicable for the moved user, then this fallback/default role will be applied).",
"format": "uri",
"title": "Move To Role (default)",
"required": true,
"displayable": false,
"choices": [],
"target_attr": "name",
"readonly": false,
"maxLength": 1024,
"target_model_type": "data/Role",
"type": "string",
"target": "/api/data/Role/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"object_class_filter": {
"is_password": false,
"description": "A filter based on matching against the user's object class.",
"title": "Object Class Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's object class.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's object class.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"l_filter": {
"is_password": false,
"description": "A filter based on matching against the user's city.",
"title": "City Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's city.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's city.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"sn_filter": {
"is_password": false,
"description": "A filter based on matching against the user's last name.",
"title": "Last Name Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's last name.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's last name.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"physical_delivery_office_name_filter": {
"is_password": false,
"description": "A filter based on matching against the user's physical delivery office name.",
"title": "Physical Delivery Office Name Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's physical delivery office name.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's physical delivery office name.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"custom_string_2_filter": {
"is_password": false,
"description": "A filter based on matching against the user's custom string 2.",
"title": "Custom String 2 Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's custom string 2.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's custom string 2.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"other_mailbox_filter": {
"is_password": false,
"description": "A filter based on matching against the user's other mailbox.",
"title": "Other Mailbox Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's other mailbox.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's other mailbox.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"title_filter": {
"is_password": false,
"description": "A filter based on matching against the user's title.",
"title": "Title Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's title.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's title.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"name": {
"is_password": false,
"description": "The name of the move filter.",
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"custom_string_5_filter": {
"is_password": false,
"description": "A filter based on matching against the user's custom string 5.",
"title": "Custom String 5 Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's custom string 5.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's custom string 5.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"mobile_filter": {
"is_password": false,
"description": "A filter based on matching against the user's mobile.",
"title": "Mobile Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's mobile.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's mobile number.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"timezone_filter": {
"is_password": false,
"description": "A filter based on matching against the user's timezone.",
"title": "Timezone Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's timezone.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's timezone.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"home_phone_filter": {
"is_password": false,
"description": "A filter based on matching against the user's home phone number.",
"title": "Home Phone Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's home phone number.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's home phone number.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"building_filter": {
"is_password": false,
"description": "A filter based on matching against the user's building name.",
"title": "Building Name Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's building name.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's building name.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"postal_filter": {
"is_password": false,
"description": "A filter based on matching against the user's postal code.",
"title": "Postal Code Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's postal code.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's postal code.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"custom_list_of_strings_2_filter": {
"is_password": false,
"description": "A filter based on matching against the user's custom list of strings 2.",
"title": "Custom List of Strings 2 Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's custom list of strings 2.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's custom list of strings 2.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"facsimile_telephone_number_filter": {
"is_password": false,
"description": "A filter based on matching against the user's FAX number.",
"title": "FAX Number Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's FAX number.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's FAX number.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"photo_url_filter": {
"is_password": false,
"description": "A filter based on matching against the user's photo URL.",
"title": "Photo URL Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's photo URL.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's photo URL.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"ip_phone_filter": {
"is_password": false,
"description": "A filter based on matching against the user's IP phone number.",
"title": "IP Phone Filter",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"value": {
"is_password": false,
"description": "The specified valued used to match against the user's IP phone number.",
"title": "Value",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"condition": {
"is_password": false,
"description": "The specified condition used to match the specified value against the user's IP phone number.",
"title": "Condition",
"required": false,
"displayable": false,
"choices": [
{
"value": "isexactly",
"title": "isexactly"
},
{
"value": "contains",
"title": "contains"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
}
},
"schema_version": "2.1.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/HcsMoveFilterDAT/add/ |
|
The GUI Add form of data/HcsMoveFilterDAT as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/data/HcsMoveFilterDAT | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/HcsMoveFilterDAT/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/HcsMoveFilterDAT/[pkid1]", "/api/data/HcsMoveFilterDAT/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/HcsMoveFilterDAT/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/HcsMoveFilterDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/HcsMoveFilterDAT/export/ |
|
{ "hrefs":["/api/data/HcsMoveFilterDAT/[pkid1]", "/api/data/HcsMoveFilterDAT/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of data/HcsMoveFilterDAT and the JSON format can be used to import instances of data/HcsMoveFilterDAT.
GET http://[host-proxy]/api/data/HcsMoveFilterDAT/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/HcsMoveFilterDAT | POST | /api/data/HcsMoveFilterDAT/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/HcsMoveFilterDAT/ |
|
The data/HcsMoveFilterDAT schema and all instances as JSON. |
(The list will return 0 to 3 data/HcsMoveFilterDAT instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"move",
"transform",
"add",
"export",
"migration",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/HcsMoveFilterDAT/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 3
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2.1.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/data/HcsMoveFilterDAT/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsMoveFilterDAT/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsMoveFilterDAT/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/data/HcsMoveFilterDAT/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/HcsMoveFilterDAT/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsMoveFilterDAT/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsMoveFilterDAT",
"model_specific_actions": [
"list",
"get",
"add",
"update",
"remove",
"import",
"export",
"export_bulkload_template",
"help"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "move_to_hn_uri",
"title": "Move To Hierarchy "
},
{
"name": "move_to_role",
"title": "Move To Role (default)"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "6130ea02e04a4a0015aa1348",
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {},
"schema_version": "2.1.1",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6130ea02e04a4a0015aa1348",
"href": "/api/data/HcsMoveFilterDAT/6130ea02e04a4a0015aa1348/"
}
],
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"foreign_key": [
{
"pkid": "6130da95e04a4a0015a9838f",
"path": "move_to_hn_uri",
"model_type": "data/HierarchyNode"
},
{
"pkid": "6130da9be04a4a0015a98477",
"path": "move_to_role",
"model_type": "data/Role"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/HcsMoveFilterDAT/6130ea02e04a4a0015aa1348/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsMoveFilterDAT/6130ea02e04a4a0015aa1348/",
"method": "DELETE",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsMoveFilterDAT/6130ea02e04a4a0015aa1348/import/",
"class": "import",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsMoveFilterDAT/6130ea02e04a4a0015aa1348/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/HcsMoveFilterDAT/6130ea02e04a4a0015aa1348/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsMoveFilterDAT/6130ea02e04a4a0015aa1348/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsMoveFilterDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"6130ea02e04a4a0015aa1348"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "move_to_hn_uri",
"title": "Move To Hierarchy "
},
{
"name": "move_to_role",
"title": "Move To Role (default)"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"name": "City-Department-Move-Filter",
"pkid": "6130ea02e04a4a0015aa134a",
"move_to_role": "LOC005SelfService",
"l_filter": {
"value": "Chic",
"condition": "contains"
},
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"move_to_hn_uri": "[\"LOC005\", \"hcs.CS-P.CS-NB.AAAGlobal\"]",
"dept_filter": {
"value": "Sales",
"condition": "isexactly"
},
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "6130e9ffe04a4a0015aa132c",
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {},
"schema_version": "2.1.1",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6130e9ffe04a4a0015aa132c",
"href": "/api/data/HcsMoveFilterDAT/6130e9ffe04a4a0015aa132c/"
}
],
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"foreign_key": [
{
"pkid": "6130da40e04a4a0015a981b8",
"path": "move_to_hn_uri",
"model_type": "data/HierarchyNode"
},
{
"pkid": "6130da46e04a4a0015a982a0",
"path": "move_to_role",
"model_type": "data/Role"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/data/HcsMoveFilterDAT/6130e9ffe04a4a0015aa132c/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/data/HcsMoveFilterDAT/6130e9ffe04a4a0015aa132c/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"import": {
"support_async": true,
"href": "/api/data/HcsMoveFilterDAT/6130e9ffe04a4a0015aa132c/import/",
"title": "Import",
"method": "POST",
"class": "import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsMoveFilterDAT/6130e9ffe04a4a0015aa132c/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/data/HcsMoveFilterDAT/6130e9ffe04a4a0015aa132c/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/data/HcsMoveFilterDAT/6130e9ffe04a4a0015aa132c/help",
"title": "Help",
"class": "help",
"method": "GET"
}
}
],
"model_type": "data/HcsMoveFilterDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"6130e9ffe04a4a0015aa132c"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "move_to_hn_uri",
"title": "Move To Hierarchy "
},
{
"name": "move_to_role",
"title": "Move To Role (default)"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"name": "Department-Move-Filter",
"pkid": "6130ea00e04a4a0015aa132e",
"move_to_role": "LOC004SelfService",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"move_to_hn_uri": "[\"LOC004\", \"hcs.CS-P.CS-NB.AAAGlobal\"]",
"dept_filter": {
"value": "Engin",
"condition": "contains"
},
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "6130e9fde04a4a0015aa1310",
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {},
"schema_version": "2.1.1",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6130e9fde04a4a0015aa1310",
"href": "/api/data/HcsMoveFilterDAT/6130e9fde04a4a0015aa1310/"
}
],
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"foreign_key": [
{
"pkid": "6130d9d9e04a4a0015a97fe0",
"path": "move_to_hn_uri",
"model_type": "data/HierarchyNode"
},
{
"pkid": "6130d9dee04a4a0015a980c8",
"path": "move_to_role",
"model_type": "data/Role"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/data/HcsMoveFilterDAT/6130e9fde04a4a0015aa1310/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/data/HcsMoveFilterDAT/6130e9fde04a4a0015aa1310/",
"class": "delete",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"class": "import",
"href": "/api/data/HcsMoveFilterDAT/6130e9fde04a4a0015aa1310/import/",
"method": "POST",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/data/HcsMoveFilterDAT/6130e9fde04a4a0015aa1310/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/data/HcsMoveFilterDAT/6130e9fde04a4a0015aa1310/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/data/HcsMoveFilterDAT/6130e9fde04a4a0015aa1310/help",
"class": "help",
"title": "Help"
}
}
],
"model_type": "data/HcsMoveFilterDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"6130e9fde04a4a0015aa1310"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "move_to_hn_uri",
"title": "Move To Hierarchy "
},
{
"name": "move_to_role",
"title": "Move To Role (default)"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"name": "Street-Move-Filter",
"move_to_hn_uri": "[\"LOC003\", \"hcs.CS-P.CS-NB.AAAGlobal\"]",
"pkid": "6130e9fde04a4a0015aa1312",
"move_to_role": "LOC003SelfService",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"street_filter": {
"value": "FountainView",
"condition": "isexactly"
},
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
}
]
}
(Show the first instance)
{
"pkid": "6130ea02e04a4a0015aa1348",
"meta": {
"tags": [],
"cached": false,
"title": "title format",
"business_key": {},
"schema_version": "2.1.1",
"references": {
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"self": [
{
"pkid": "6130ea02e04a4a0015aa1348",
"href": "/api/data/HcsMoveFilterDAT/6130ea02e04a4a0015aa1348/"
}
],
"foreign_key": [
{
"pkid": "6130da95e04a4a0015a9838f",
"path": "move_to_hn_uri",
"model_type": "data/HierarchyNode"
},
{
"pkid": "6130da9be04a4a0015a98477",
"path": "move_to_role",
"model_type": "data/Role"
}
],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/HcsMoveFilterDAT/6130ea02e04a4a0015aa1348/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsMoveFilterDAT/6130ea02e04a4a0015aa1348/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsMoveFilterDAT/6130ea02e04a4a0015aa1348/import/?hierarchy=[hierarchy]",
"class": "import",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsMoveFilterDAT/6130ea02e04a4a0015aa1348/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/HcsMoveFilterDAT/6130ea02e04a4a0015aa1348/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsMoveFilterDAT/6130ea02e04a4a0015aa1348/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsMoveFilterDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"6130ea02e04a4a0015aa1348"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "move_to_hn_uri",
"title": "Move To Hierarchy "
},
{
"name": "move_to_role",
"title": "Move To Role (default)"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"name": "City-Department-Move-Filter",
"pkid": "6130ea02e04a4a0015aa134a",
"move_to_role": "LOC005SelfService",
"l_filter": {
"condition": "contains",
"value": "Chic"
},
"dept_filter": {
"condition": "isexactly",
"value": "Sales"
},
"move_to_hn_uri": "[\"LOC005\", \"hcs.CS-P.CS-NB.AAAGlobal\"]"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/HcsMoveFilterDAT. | GET | /api/data/HcsMoveFilterDAT/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/HcsMoveFilterDAT as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/HcsMoveFilterDAT/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/HcsMoveFilterDAT/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Import | POST | /api/data/HcsMoveFilterDAT/[pkid]/import | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/HcsMoveFilterDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/HcsMoveFilterDAT/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of data/HcsMoveFilterDAT and the JSON format can be used to import instances of data/HcsMoveFilterDAT.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/HcsMoveFilterDAT/[pkid] | hierarchy=[hierarchy] | The data/HcsMoveFilterDAT instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/HcsMoveFilterDAT/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/HcsMoveFilterDAT. |