[Index]
Model ref.: relation/GS_FMCv2_User_REL
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": {
"username": {
"type": "string",
"description": "Username",
"title": "Username"
},
"fmc": {
"type": "object",
"description": "FMC",
"title": "FMC",
"properties": {
"enabled": {
"type": "boolean",
"description": "Enabled",
"title": "Enabled"
},
"mobile": {
"type": "string",
"description": "Mobile Number",
"title": "Mobile Number"
},
"called_party_transformation_pattern_route_partition": {
"type": "string",
"description": "Partition for CdP transformation",
"title": "Partition for CdP transformation"
}
}
},
"option_mobile_make_display": {
"target": "/api/data/GS_FMCv2_MobileMake_DAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Mobile Make",
"type": "string",
"description": "Mobile Make",
"target_model_type": "data/GS_FMCv2_MobileMake_DAT",
"choices": []
},
"option_data_display": {
"target": "/api/data/GS_FMCv2_DataOption_DAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Data Option",
"type": "string",
"description": "User Data Option",
"target_model_type": "data/GS_FMCv2_DataOption_DAT",
"choices": []
},
"option_roaming_display": {
"target": "/api/data/GS_FMCv2_RoamingOption_DAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Roaming Option",
"type": "string",
"description": "User Roaming Option",
"target_model_type": "data/GS_FMCv2_RoamingOption_DAT",
"choices": []
},
"cliOption": {
"choices": [
{
"value": "E164",
"title": "Fixed E164 number"
},
{
"value": "msisdn",
"title": "Mobile Number"
}
],
"type": "string",
"description": "Number to present on outbound calls",
"title": "CLI Option"
},
"dn": {
"type": "string",
"title": "Directory Number"
},
"dnE164": {
"type": "string",
"title": "E164 mapped to DN"
},
"overrideTP": {
"default": "false",
"type": "boolean",
"description": "Used to indicate if a calling party trans pattern is created for FMC",
"title": "User has FMC specific Translation Pattern"
},
"origCli": {
"type": "string",
"title": "Original E164 CLI"
},
"isCliMaskLoaded": {
"type": "boolean",
"title": "Is CLI Mask adaptation loaded"
},
"origCimMask": {
"type": "string",
"title": "Original Line Mask On CIM"
},
"timeScheduleName": {
"type": "string",
"title": "Time Schedule Name"
},
"allowUsernameChange": {
"type": "boolean",
"description": "Only allow username change where username is not used for device naming",
"title": "Allow Username Change"
},
"NoInstance": {
"title": "No Instance",
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"UserTS": {
"title": "User Ts",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string",
"maxLength": 50
},
"members": {
"title": "Members",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"member": {
"name": "member",
"title": "Member",
"minItems": 1,
"required": true,
"type": "array",
"items": {
"type": [
"object",
"null"
],
"properties": {
"timePeriodName": {
"name": "timePeriodName",
"title": "Time Period Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
}
}
}
}
}
},
"description": {
"title": "Description",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"maxLength": 255
},
"isPublished": {
"description": "TimeSchedule cannot be published if it has a todOwnerId assigned to it. Only Administrative Time Schedule can be published.",
"title": "Is Published",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": false,
"type": "boolean"
},
"timeScheduleCategory": {
"title": "Time Schedule Category",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "Regular",
"type": "string",
"choices": [
{
"title": "Regular",
"value": "Regular"
},
{
"title": "Holiday or Vacation",
"value": "Holiday or Vacation"
}
]
},
"todOwnerIdName": {
"title": "Tod Owner Id Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/User/choices/?field=userid&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "userid",
"target_model_type": "device/cucm/User",
"choices": []
},
"UserTP": {
"title": "User Tp",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Enter a name in the Time Period Name field. The name can comprise up to 50 alphanumeric characters and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_). Ensure each time period name is unique to the plan. \n \n \n \n Note\u00a0\u00a0\u00a0 \n Use concise and descriptive names for your time periods. The hours_or_days format usually provides a sufficient level of detail and is short enough to enable you to quickly and easily identify a time period. For example, office_M_to_F identifies a time period for the business hours of an office from Monday to Friday. \n \n \n \n Cisco Unified Communications Manager provides the All the time\u00a0time period. This special, system time period includes all hours, is published to end users, and cannot be deleted; this time period can be copied. ",
"title": "Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string",
"maxLength": 50
},
"startTime": {
"description": "From the drop-down list box, choose the time when this time period starts. The available listed start times comprise 15-minute intervals throughout a 24-hour day. The default value is No Office Hours. \n \n \n \n Note\u00a0\u00a0\u00a0 \n To start a time period at midnight, choose the 00:00 value. \n \n \n ",
"title": "Time Of Day Start",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "No Office Hours",
"type": "string",
"choices": [
{
"title": "No Office Hours",
"value": "No Office Hours"
},
{
"title": "00:00",
"value": "00:00"
},
{
"title": "00:15",
"value": "00:15"
},
{
"title": "00:30",
"value": "00:30"
},
{
"title": "00:45",
"value": "00:45"
},
{
"title": "01:00",
"value": "01:00"
},
{
"title": "01:15",
"value": "01:15"
},
{
"title": "01:30",
"value": "01:30"
},
{
"title": "01:45",
"value": "01:45"
},
{
"title": "02:00",
"value": "02:00"
},
{
"title": "02:15",
"value": "02:15"
},
{
"title": "02:30",
"value": "02:30"
},
{
"title": "02:45",
"value": "02:45"
},
{
"title": "03:00",
"value": "03:00"
},
{
"title": "03:15",
"value": "03:15"
},
{
"title": "03:30",
"value": "03:30"
},
{
"title": "03:45",
"value": "03:45"
},
{
"title": "04:00",
"value": "04:00"
},
{
"title": "04:15",
"value": "04:15"
},
{
"title": "04:30",
"value": "04:30"
},
{
"title": "04:45",
"value": "04:45"
},
{
"title": "05:00",
"value": "05:00"
},
{
"title": "05:15",
"value": "05:15"
},
{
"title": "05:30",
"value": "05:30"
},
{
"title": "05:45",
"value": "05:45"
},
{
"title": "06:00",
"value": "06:00"
},
{
"title": "06:15",
"value": "06:15"
},
{
"title": "06:30",
"value": "06:30"
},
{
"title": "06:45",
"value": "06:45"
},
{
"title": "07:00",
"value": "07:00"
},
{
"title": "07:15",
"value": "07:15"
},
{
"title": "07:30",
"value": "07:30"
},
{
"title": "07:45",
"value": "07:45"
},
{
"title": "08:00",
"value": "08:00"
},
{
"title": "08:15",
"value": "08:15"
},
{
"title": "08:30",
"value": "08:30"
},
{
"title": "08:45",
"value": "08:45"
},
{
"title": "09:00",
"value": "09:00"
},
{
"title": "09:15",
"value": "09:15"
},
{
"title": "09:30",
"value": "09:30"
},
{
"title": "09:45",
"value": "09:45"
},
{
"title": "10:00",
"value": "10:00"
},
{
"title": "10:15",
"value": "10:15"
},
{
"title": "10:30",
"value": "10:30"
},
{
"title": "10:45",
"value": "10:45"
},
{
"title": "11:00",
"value": "11:00"
},
{
"title": "11:15",
"value": "11:15"
},
{
"title": "11:30",
"value": "11:30"
},
{
"title": "11:45",
"value": "11:45"
},
{
"title": "12:00",
"value": "12:00"
},
{
"title": "12:15",
"value": "12:15"
},
{
"title": "12:30",
"value": "12:30"
},
{
"title": "12:45",
"value": "12:45"
},
{
"title": "13:00",
"value": "13:00"
},
{
"title": "13:15",
"value": "13:15"
},
{
"title": "13:30",
"value": "13:30"
},
{
"title": "13:45",
"value": "13:45"
},
{
"title": "14:00",
"value": "14:00"
},
{
"title": "14:15",
"value": "14:15"
},
{
"title": "14:30",
"value": "14:30"
},
{
"title": "14:45",
"value": "14:45"
},
{
"title": "15:00",
"value": "15:00"
},
{
"title": "15:15",
"value": "15:15"
},
{
"title": "15:30",
"value": "15:30"
},
{
"title": "15:45",
"value": "15:45"
},
{
"title": "16:00",
"value": "16:00"
},
{
"title": "16:15",
"value": "16:15"
},
{
"title": "16:30",
"value": "16:30"
},
{
"title": "16:45",
"value": "16:45"
},
{
"title": "17:00",
"value": "17:00"
},
{
"title": "17:15",
"value": "17:15"
},
{
"title": "17:30",
"value": "17:30"
},
{
"title": "17:45",
"value": "17:45"
},
{
"title": "18:00",
"value": "18:00"
},
{
"title": "18:15",
"value": "18:15"
},
{
"title": "18:30",
"value": "18:30"
},
{
"title": "18:45",
"value": "18:45"
},
{
"title": "19:00",
"value": "19:00"
},
{
"title": "19:15",
"value": "19:15"
},
{
"title": "19:30",
"value": "19:30"
},
{
"title": "19:45",
"value": "19:45"
},
{
"title": "20:00",
"value": "20:00"
},
{
"title": "20:15",
"value": "20:15"
},
{
"title": "20:30",
"value": "20:30"
},
{
"title": "20:45",
"value": "20:45"
},
{
"title": "21:00",
"value": "21:00"
},
{
"title": "21:15",
"value": "21:15"
},
{
"title": "21:30",
"value": "21:30"
},
{
"title": "21:45",
"value": "21:45"
},
{
"title": "22:00",
"value": "22:00"
},
{
"title": "22:15",
"value": "22:15"
},
{
"title": "22:30",
"value": "22:30"
},
{
"title": "22:45",
"value": "22:45"
},
{
"title": "23:00",
"value": "23:00"
},
{
"title": "23:15",
"value": "23:15"
},
{
"title": "23:30",
"value": "23:30"
},
{
"title": "23:45",
"value": "23:45"
},
{
"title": "24:00",
"value": "24:00"
}
]
},
"endTime": {
"description": "From the drop-down list box, choose the time when this time period ends. The available listed end times comprise 15-minute intervals throughout a 24-hour day. The default value is No Office Hours. \n \n \n \n Note\u00a0\u00a0\u00a0 \n You must choose an End Time that is later than the Start Time that you chose. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n To end a time period at midnight, choose the 24:00 value. \n \n \n ",
"title": "Time of Day End",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "No Office Hours",
"type": "string",
"choices": [
{
"title": "No Office Hours",
"value": "No Office Hours"
},
{
"title": "00:00",
"value": "00:00"
},
{
"title": "00:15",
"value": "00:15"
},
{
"title": "00:30",
"value": "00:30"
},
{
"title": "00:45",
"value": "00:45"
},
{
"title": "01:00",
"value": "01:00"
},
{
"title": "01:15",
"value": "01:15"
},
{
"title": "01:30",
"value": "01:30"
},
{
"title": "01:45",
"value": "01:45"
},
{
"title": "02:00",
"value": "02:00"
},
{
"title": "02:15",
"value": "02:15"
},
{
"title": "02:30",
"value": "02:30"
},
{
"title": "02:45",
"value": "02:45"
},
{
"title": "03:00",
"value": "03:00"
},
{
"title": "03:15",
"value": "03:15"
},
{
"title": "03:30",
"value": "03:30"
},
{
"title": "03:45",
"value": "03:45"
},
{
"title": "04:00",
"value": "04:00"
},
{
"title": "04:15",
"value": "04:15"
},
{
"title": "04:30",
"value": "04:30"
},
{
"title": "04:45",
"value": "04:45"
},
{
"title": "05:00",
"value": "05:00"
},
{
"title": "05:15",
"value": "05:15"
},
{
"title": "05:30",
"value": "05:30"
},
{
"title": "05:45",
"value": "05:45"
},
{
"title": "06:00",
"value": "06:00"
},
{
"title": "06:15",
"value": "06:15"
},
{
"title": "06:30",
"value": "06:30"
},
{
"title": "06:45",
"value": "06:45"
},
{
"title": "07:00",
"value": "07:00"
},
{
"title": "07:15",
"value": "07:15"
},
{
"title": "07:30",
"value": "07:30"
},
{
"title": "07:45",
"value": "07:45"
},
{
"title": "08:00",
"value": "08:00"
},
{
"title": "08:15",
"value": "08:15"
},
{
"title": "08:30",
"value": "08:30"
},
{
"title": "08:45",
"value": "08:45"
},
{
"title": "09:00",
"value": "09:00"
},
{
"title": "09:15",
"value": "09:15"
},
{
"title": "09:30",
"value": "09:30"
},
{
"title": "09:45",
"value": "09:45"
},
{
"title": "10:00",
"value": "10:00"
},
{
"title": "10:15",
"value": "10:15"
},
{
"title": "10:30",
"value": "10:30"
},
{
"title": "10:45",
"value": "10:45"
},
{
"title": "11:00",
"value": "11:00"
},
{
"title": "11:15",
"value": "11:15"
},
{
"title": "11:30",
"value": "11:30"
},
{
"title": "11:45",
"value": "11:45"
},
{
"title": "12:00",
"value": "12:00"
},
{
"title": "12:15",
"value": "12:15"
},
{
"title": "12:30",
"value": "12:30"
},
{
"title": "12:45",
"value": "12:45"
},
{
"title": "13:00",
"value": "13:00"
},
{
"title": "13:15",
"value": "13:15"
},
{
"title": "13:30",
"value": "13:30"
},
{
"title": "13:45",
"value": "13:45"
},
{
"title": "14:00",
"value": "14:00"
},
{
"title": "14:15",
"value": "14:15"
},
{
"title": "14:30",
"value": "14:30"
},
{
"title": "14:45",
"value": "14:45"
},
{
"title": "15:00",
"value": "15:00"
},
{
"title": "15:15",
"value": "15:15"
},
{
"title": "15:30",
"value": "15:30"
},
{
"title": "15:45",
"value": "15:45"
},
{
"title": "16:00",
"value": "16:00"
},
{
"title": "16:15",
"value": "16:15"
},
{
"title": "16:30",
"value": "16:30"
},
{
"title": "16:45",
"value": "16:45"
},
{
"title": "17:00",
"value": "17:00"
},
{
"title": "17:15",
"value": "17:15"
},
{
"title": "17:30",
"value": "17:30"
},
{
"title": "17:45",
"value": "17:45"
},
{
"title": "18:00",
"value": "18:00"
},
{
"title": "18:15",
"value": "18:15"
},
{
"title": "18:30",
"value": "18:30"
},
{
"title": "18:45",
"value": "18:45"
},
{
"title": "19:00",
"value": "19:00"
},
{
"title": "19:15",
"value": "19:15"
},
{
"title": "19:30",
"value": "19:30"
},
{
"title": "19:45",
"value": "19:45"
},
{
"title": "20:00",
"value": "20:00"
},
{
"title": "20:15",
"value": "20:15"
},
{
"title": "20:30",
"value": "20:30"
},
{
"title": "20:45",
"value": "20:45"
},
{
"title": "21:00",
"value": "21:00"
},
{
"title": "21:15",
"value": "21:15"
},
{
"title": "21:30",
"value": "21:30"
},
{
"title": "21:45",
"value": "21:45"
},
{
"title": "22:00",
"value": "22:00"
},
{
"title": "22:15",
"value": "22:15"
},
{
"title": "22:30",
"value": "22:30"
},
{
"title": "22:45",
"value": "22:45"
},
{
"title": "23:00",
"value": "23:00"
},
{
"title": "23:15",
"value": "23:15"
},
{
"title": "23:30",
"value": "23:30"
},
{
"title": "23:45",
"value": "23:45"
},
{
"title": "24:00",
"value": "24:00"
}
]
},
"startDay": {
"title": "Day of Week Start",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "None",
"type": "string",
"choices": [
{
"title": "Sun",
"value": "Sun"
},
{
"title": "Mon",
"value": "Mon"
},
{
"title": "Tue",
"value": "Tue"
},
{
"title": "Wed",
"value": "Wed"
},
{
"title": "Thu",
"value": "Thu"
},
{
"title": "Fri",
"value": "Fri"
},
{
"title": "Sat",
"value": "Sat"
},
{
"title": "None",
"value": "None"
}
]
},
"endDay": {
"title": "Day of Week End",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "None",
"type": "string",
"choices": [
{
"title": "Sun",
"value": "Sun"
},
{
"title": "Mon",
"value": "Mon"
},
{
"title": "Tue",
"value": "Tue"
},
{
"title": "Wed",
"value": "Wed"
},
{
"title": "Thu",
"value": "Thu"
},
{
"title": "Fri",
"value": "Fri"
},
{
"title": "Sat",
"value": "Sat"
},
{
"title": "None",
"value": "None"
}
]
},
"monthOfYear": {
"title": "Month Of Year",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "None",
"type": "string",
"choices": [
{
"title": "None",
"value": "None"
},
{
"title": "Jan",
"value": "Jan"
},
{
"title": "Feb",
"value": "Feb"
},
{
"title": "Mar",
"value": "Mar"
},
{
"title": "Apr",
"value": "Apr"
},
{
"title": "May",
"value": "May"
},
{
"title": "Jun",
"value": "Jun"
},
{
"title": "Jul",
"value": "Jul"
},
{
"title": "Aug",
"value": "Aug"
},
{
"title": "Sep",
"value": "Sep"
},
{
"title": "Oct",
"value": "Oct"
},
{
"title": "Nov",
"value": "Nov"
},
{
"title": "Dec",
"value": "Dec"
}
]
},
"dayOfMonth": {
"title": "Day of Month",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": 0,
"type": "integer"
},
"description": {
"description": "Enter a description for this time period. ",
"title": "Description",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"maxLength": 255
},
"isPublished": {
"description": "TimePeriod cannot be published if it has a todOwnerId assigned to it. Only Administrative Time Period can be published.",
"title": "Is Published",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"todOwnerIdName": {
"title": "Tod Owner Id Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/User/choices/?field=userid&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "userid",
"target_model_type": "device/cucm/User",
"choices": []
},
"dayOfMonthEnd": {
"title": "Day of Month End",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": 0,
"type": "integer"
},
"monthOfYearEnd": {
"title": "Month of Year End",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "None",
"type": "string",
"choices": [
{
"title": "None",
"value": "None"
},
{
"title": "Jan",
"value": "Jan"
},
{
"title": "Feb",
"value": "Feb"
},
{
"title": "Mar",
"value": "Mar"
},
{
"title": "Apr",
"value": "Apr"
},
{
"title": "May",
"value": "May"
},
{
"title": "Jun",
"value": "Jun"
},
{
"title": "Jul",
"value": "Jul"
},
{
"title": "Aug",
"value": "Aug"
},
{
"title": "Sep",
"value": "Sep"
},
{
"title": "Oct",
"value": "Oct"
},
{
"title": "Nov",
"value": "Nov"
},
{
"title": "Dec",
"value": "Dec"
}
]
}
}
}
}
}
}
}
}
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/relation/GS_FMCv2_User_REL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/GS_FMCv2_User_REL/[pkid1]", "/api/relation/GS_FMCv2_User_REL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/GS_FMCv2_User_REL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/GS_FMCv2_User_REL |
|
{"hrefs": ["/api/relation/GS_FMCv2_User_REL/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=relation/GS_FMCv2_User_REL |
|
{"hrefs": ["/api/relation/GS_FMCv2_User_REL/[pkid1]", "/api/relation/GS_FMCv2_User_REL/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/GS_FMCv2_User_REL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/GS_FMCv2_User_REL/export/ |
|
{ "hrefs":["/api/relation/GS_FMCv2_User_REL/[pkid1]", "/api/relation/GS_FMCv2_User_REL/[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 relation/GS_FMCv2_User_REL and the JSON format can be used to import instances of relation/GS_FMCv2_User_REL.
GET http://[host-proxy]/api/relation/GS_FMCv2_User_REL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/GS_FMCv2_User_REL | POST | /api/relation/GS_FMCv2_User_REL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/relation/GS_FMCv2_User_REL/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/GS_FMCv2_User_REL/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/GS_FMCv2_User_REL/ |
|
The relation/GS_FMCv2_User_REL schema and all instances as JSON. |
(The list will return 0 to 3 relation/GS_FMCv2_User_REL instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 1,
"total_limit": null,
"order_by": "username",
"direction": "asc",
"current": "/api/relation/GS_FMCv2_User_REL/?skip=0&limit=3&order_by=username&direction=asc&traversal=fulltree"
},
"operations": [
"bulk_update",
"help",
"export",
"configuration_template",
"field_display_policy",
"get",
"update",
"list",
"move",
"add",
"remove",
"export_bulkload_template"
],
"meta": {
"model_type": "relation/GS_FMCv2_User_REL",
"summary_attrs": [
{
"name": "username",
"title": "Username"
},
{
"name": "fmc.mobile",
"title": "Mobile Number",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/GS_FMCv2_User_REL/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"export",
"configuration_template",
"field_display_policy",
"update",
"get",
"list",
"move",
"add",
"remove",
"export_bulkload_template"
],
"schema_version": null,
"actions": [
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/GS_FMCv2_User_REL/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/GS_FMCv2_User_REL",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/GS_FMCv2_User_REL/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/relation/GS_FMCv2_User_REL/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/relation/GS_FMCv2_User_REL/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/relation/GS_FMCv2_User_REL/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/GS_FMCv2_User_REL/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
}
]
},
"resources": [
{
"data": {
"username": "bat.man",
"dn": "8211226",
"timeScheduleName": "TS-bat.man-CIM",
"cliOption": "E164",
"fmc": {
"mobile": "+2130198211226",
"called_party_transformation_pattern_route_partition": "Cu4-FMCCalledTransf-PT",
"enabled": true
},
"pkid": "62cd53b17c683e4967dc06da",
"hierarchy_friendly_name": "CL1-AB-C-Berlin (Site)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C.CL1-AB-C-Berlin"
},
"meta": {
"model_type": "relation/GS_FMCv2_User_REL",
"summary_attrs": [
{
"name": "username",
"title": "Username"
},
{
"name": "fmc.mobile",
"title": "Mobile Number",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "bat.man",
"business_key": {
"hierarchy": true,
"unique": [
"username"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5a86d2bb67ea6f2039948528",
"href": "/api/data/HierarchyNode/5a86d2bb67ea6f2039948528"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/GS_FMCv2_User_REL/62cd53b17c683e4967dc06d9/",
"pkid": "62cd53b17c683e4967dc06d9"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5a7c462e1360b64cc8bf16e5",
"5a866fd11360b6206c488deb",
"5a86704db12a1c20228be944",
"5a86cc291360b6206c49e71e",
"5a86cee1939cd122e185cb08",
"5a86d2bb67ea6f2039948528",
"62cd53b17c683e4967dc06d9"
],
"schema_version": "0.3",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/GS_FMCv2_User_REL/62cd53b17c683e4967dc06d9/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/GS_FMCv2_User_REL/62cd53b17c683e4967dc06d9/",
"support_async": true,
"title": "Delete"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/62cd53b17c683e4967dc06d9/?model_type=relation/GS_FMCv2_User_REL",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/GS_FMCv2_User_REL/62cd53b17c683e4967dc06d9/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/GS_FMCv2_User_REL/62cd53b17c683e4967dc06d9/",
"support_async": false,
"title": "Get"
}
}
],
"summary": "false"
},
"pkid": "62cd53b17c683e4967dc06d9"
}
]
}
(Show the first instance)
{
"data": {
"username": "bat.man",
"dn": "8211226",
"timeScheduleName": "TS-bat.man-CIM",
"cliOption": "E164",
"fmc": {
"mobile": "+2130198211226",
"called_party_transformation_pattern_route_partition": "Cu4-FMCCalledTransf-PT",
"enabled": true
},
"UserTS": [
{
"name": "TS-bat.man-CIM",
"isPublished": false,
"timeScheduleCategory": "Regular",
"members": {
"member": [
{
"timePeriodName": "TP-bat.man-CIM-Thu"
},
{
"timePeriodName": "TP-bat.man-CIM-Tue"
},
{
"timePeriodName": "TP-bat.man-CIM-Sun"
},
{
"timePeriodName": "TP-bat.man-CIM-Sat"
},
{
"timePeriodName": "TP-bat.man-CIM-Wed"
},
{
"timePeriodName": "TP-bat.man-CIM-Mon"
},
{
"timePeriodName": "TP-bat.man-CIM-Fri"
}
]
},
"todOwnerIdName": "bat.man",
"description": "TS-bat.man-CIM",
"UserTP": [
{
"name": "TP-bat.man-CIM-Thu",
"endDay": "Thu",
"startDay": "Thu",
"isPublished": false,
"monthOfYearEnd": "None",
"monthOfYear": "None",
"startTime": "00:00",
"dayOfMonthEnd": 0,
"todOwnerIdName": "bat.man",
"endTime": "24:00",
"dayOfMonth": 0
},
{
"name": "TP-bat.man-CIM-Tue",
"endDay": "Tue",
"startDay": "Tue",
"isPublished": false,
"monthOfYearEnd": "None",
"monthOfYear": "None",
"startTime": "00:00",
"dayOfMonthEnd": 0,
"todOwnerIdName": "bat.man",
"endTime": "24:00",
"dayOfMonth": 0
},
{
"name": "TP-bat.man-CIM-Sun",
"endDay": "Sun",
"startDay": "Sun",
"isPublished": false,
"monthOfYearEnd": "None",
"monthOfYear": "None",
"startTime": "00:00",
"dayOfMonthEnd": 0,
"todOwnerIdName": "bat.man",
"endTime": "24:00",
"dayOfMonth": 0
},
{
"name": "TP-bat.man-CIM-Sat",
"endDay": "Sat",
"startDay": "Sat",
"isPublished": false,
"monthOfYearEnd": "None",
"monthOfYear": "None",
"startTime": "00:00",
"dayOfMonthEnd": 0,
"todOwnerIdName": "bat.man",
"endTime": "24:00",
"dayOfMonth": 0
},
{
"name": "TP-bat.man-CIM-Wed",
"endDay": "Wed",
"startDay": "Wed",
"isPublished": false,
"monthOfYearEnd": "None",
"monthOfYear": "None",
"startTime": "00:00",
"dayOfMonthEnd": 0,
"todOwnerIdName": "bat.man",
"endTime": "24:00",
"dayOfMonth": 0
},
{
"name": "TP-bat.man-CIM-Mon",
"endDay": "Mon",
"startDay": "Mon",
"isPublished": false,
"monthOfYearEnd": "None",
"monthOfYear": "None",
"startTime": "00:00",
"dayOfMonthEnd": 0,
"todOwnerIdName": "bat.man",
"endTime": "24:00",
"dayOfMonth": 0
},
{
"name": "TP-bat.man-CIM-Fri",
"endDay": "Fri",
"startDay": "Fri",
"isPublished": false,
"monthOfYearEnd": "None",
"monthOfYear": "None",
"startTime": "00:00",
"dayOfMonthEnd": 0,
"todOwnerIdName": "bat.man",
"endTime": "24:00",
"dayOfMonth": 0
}
]
}
]
},
"meta": {
"model_type": "relation/GS_FMCv2_User_REL",
"summary_attrs": [
{
"name": "username",
"title": "Username"
},
{
"name": "fmc.mobile",
"title": "Mobile Number",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "bat.man",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"children": [],
"parent": [
{
"pkid": "5a86d2bb67ea6f2039948528",
"href": "/api/data/HierarchyNode/5a86d2bb67ea6f2039948528"
}
],
"self": [
{
"href": "/api/relation/GS_FMCv2_User_REL/62cd53b17c683e4967dc06d9/",
"pkid": "62cd53b17c683e4967dc06d9"
}
]
},
"schema_version": null,
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/GS_FMCv2_User_REL/62cd53b17c683e4967dc06d9/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/GS_FMCv2_User_REL/62cd53b17c683e4967dc06d9/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/62cd53b17c683e4967dc06d9/?hierarchy=[hierarchy]&model_type=relation/GS_FMCv2_User_REL",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/GS_FMCv2_User_REL/62cd53b17c683e4967dc06d9/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/GS_FMCv2_User_REL/62cd53b17c683e4967dc06d9/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
}
]
},
"pkid": "62cd53b17c683e4967dc06d9"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/GS_FMCv2_User_REL/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/GS_FMCv2_User_REL/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/GS_FMCv2_User_REL | 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 relation/GS_FMCv2_User_REL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/GS_FMCv2_User_REL/[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 relation/GS_FMCv2_User_REL and the JSON format can be used to import instances of relation/GS_FMCv2_User_REL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/GS_FMCv2_User_REL/[pkid] | hierarchy=[hierarchy] | The relation/GS_FMCv2_User_REL instance with [pkid]. |