[Index]
Model ref.: device/webex/Meeting
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": { "accessControl": { "title": "Access Control", "minItems": 0, "required": false, "maxItems": 1, "type": "object", "properties": { "listToPublic": { "name": "listToPublic", "title": "List To Public", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "meetingPassword": { "name": "meetingPassword", "title": "Meeting Password", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 16, "type": "string" }, "isPublic": { "name": "isPublic", "title": "Is Public", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "enforcePassword": { "name": "enforcePassword", "title": "Enforce Password", "minItems": 0, "required": false, "default": true, "maxItems": 1, "type": "boolean" } } }, "status": { "minItems": 0, "required": false, "type": "string", "maxItems": 1, "title": "Status" }, "assistService": { "title": "Assist Service", "minItems": 0, "required": false, "maxItems": 1, "type": "object", "properties": { "assistRequest": { "name": "assistRequest", "title": "Assist Request", "minItems": 0, "required": false, "choices": [ [ "None", "None" ], [ "Dry Run", "Dry Run" ], [ "Consult", "Consult" ], [ "Live Event Support", "Live Event Support" ], [ "Audio Streaming", "Audio Streaming" ], [ "Video", "Video" ] ], "maxItems": 1, "type": "string" }, "assistConfirm": { "name": "assistConfirm", "title": "Assist Confirm", "minItems": 0, "required": false, "choices": [ [ "Pending", "Pending" ], [ "Confirmed", "Confirmed" ], [ "Cancelled", "Cancelled" ] ], "maxItems": 1, "type": "string" } } }, "schedule": { "title": "Schedule", "minItems": 0, "required": false, "maxItems": 1, "type": "object", "properties": { "timeZoneID": { "name": "timeZoneID", "title": "Time Zone ID", "minItems": 0, "required": false, "default": -1, "maxItems": 1, "type": "integer" }, "startDate": { "name": "startDate", "title": "Start Date (MM/DD/YYYY hh:mm:ss)", "minItems": 0, "required": true, "maxItems": 1, "type": "string" }, "openTime": { "name": "openTime", "title": "Open Time", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "showFilePath": { "name": "showFilePath", "title": "Show File Path", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "hostWebExID": { "name": "hostWebExID", "title": "Host Web Ex ID", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "templateFilePath": { "name": "templateFilePath", "title": "Template File Path", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "extURL": { "name": "extURL", "title": "Ext URL", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 512, "type": "string" }, "showFileStartMode": { "name": "showFileStartMode", "title": "Show File Start Mode", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "firstAttendeeAsPresenter": { "name": "firstAttendeeAsPresenter", "title": "First Attendee As Presenter", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "joinTeleconfBeforeHost": { "name": "joinTeleconfBeforeHost", "title": "Join Teleconf Before Host", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "extNotifyTime": { "name": "extNotifyTime", "title": "Ext Notify Time", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "entryExitTone": { "name": "entryExitTone", "title": "Entry Exit Tone", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "joinNotifyURL": { "name": "joinNotifyURL", "title": "Join Notify URL", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 512, "type": "string" }, "duration": { "name": "duration", "title": "Duration", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "timeZone": { "name": "timeZone", "title": "Time Zone", "minItems": 0, "required": false, "choices": [ [ "GMT-12:00, Dateline (Eniwetok)", "GMT-12:00, Dateline (Eniwetok)" ], [ "GMT-11:00, Samoa (Samoa)", "GMT-11:00, Samoa (Samoa)" ], [ "GMT-10:00, Hawaii (Honolulu)", "GMT-10:00, Hawaii (Honolulu)" ], [ "GMT-09:00, Alaska (Ancorage)", "GMT-09:00, Alaska (Ancorage)" ], [ "GMT-08:00, Pacific (San Jose)", "GMT-08:00, Pacific (San Jose)" ], [ "GMT-07:00, Mountain (Arizona)", "GMT-07:00, Mountain (Arizona)" ], [ "GMT-07:00, Mountain (Denver)", "GMT-07:00, Mountain (Denver)" ], [ "GMT-06:00, Central (Chicago)", "GMT-06:00, Central (Chicago)" ], [ "GMT-06:00, Mexico (Mexico City,Tegucigalpa)", "GMT-06:00, Mexico (Mexico City,Tegucigalpa)" ], [ "GMT-06:00, Central (Regina)", "GMT-06:00, Central (Regina)" ], [ "GMT-05:00, S. America Pacific (Bogota)", "GMT-05:00, S. America Pacific (Bogota)" ], [ "GMT-05:00, Eastern (New York)", "GMT-05:00, Eastern (New York)" ], [ "GMT-05:00, Eastern (Indiana)", "GMT-05:00, Eastern (Indiana)" ], [ "GMT-04:00, Atlantic (Halifax)", "GMT-04:00, Atlantic (Halifax)" ], [ "GMT-04:00, S. America Western (Caracas)", "GMT-04:00, S. America Western (Caracas)" ], [ "GMT-03:30, Newfoundland (Newfoundland)", "GMT-03:30, Newfoundland (Newfoundland)" ], [ "GMT-03:00, S. America Eastern (Brasilia)", "GMT-03:00, S. America Eastern (Brasilia)" ], [ "GMT-03:00, S. America Eastern (Buenos Aires)", "GMT-03:00, S. America Eastern (Buenos Aires)" ], [ "GMT-02:00, Mid-Atlantic (Mid-Atlantic)", "GMT-02:00, Mid-Atlantic (Mid-Atlantic)" ], [ "GMT-01:00, Azores (Azores)", "GMT-01:00, Azores (Azores)" ], [ "GMT+00:00, Greenwich (Casablanca)", "GMT+00:00, Greenwich (Casablanca)" ], [ "GMT+00:00, GMT (London)", "GMT+00:00, GMT (London)" ], [ "GMT+01:00, Europe (Amsterdam)", "GMT+01:00, Europe (Amsterdam)" ], [ "GMT+01:00, Europe (Paris)", "GMT+01:00, Europe (Paris)" ], [ "GMT+01:00, Europe (Prague)", "GMT+01:00, Europe (Prague)" ], [ "GMT+01:00, Europe (Berlin)", "GMT+01:00, Europe (Berlin)" ], [ "GMT+02:00, Greece (Athens)", "GMT+02:00, Greece (Athens)" ], [ "GMT+02:00, Eastern Europe (Bucharest)", "GMT+02:00, Eastern Europe (Bucharest)" ], [ "GMT+02:00, Egypt (Cairo)", "GMT+02:00, Egypt (Cairo)" ], [ "GMT+02:00, South Africa (Pretoria)", "GMT+02:00, South Africa (Pretoria)" ], [ "GMT+02:00, Northern Europe (Helsinki)", "GMT+02:00, Northern Europe (Helsinki)" ], [ "GMT+02:00, Israel (Tel Aviv)", "GMT+02:00, Israel (Tel Aviv)" ], [ "GMT+03:00, Saudi Arabia (Baghdad)", "GMT+03:00, Saudi Arabia (Baghdad)" ], [ "GMT+03:00, Russian (Moscow)", "GMT+03:00, Russian (Moscow)" ], [ "GMT+03:00, Nairobi (Nairobi)", "GMT+03:00, Nairobi (Nairobi)" ], [ "GMT+03:00, Iran (Tehran)", "GMT+03:00, Iran (Tehran)" ], [ "GMT+04:00, Arabian (Abu Dhabi, Muscat)", "GMT+04:00, Arabian (Abu Dhabi, Muscat)" ], [ "GMT+04:00, Baku (Baku)", "GMT+04:00, Baku (Baku)" ], [ "GMT+04:00, Afghanistan (Kabul)", "GMT+04:00, Afghanistan (Kabul)" ], [ "GMT+05:00, West Asia (Ekaterinburg)", "GMT+05:00, West Asia (Ekaterinburg)" ], [ "GMT+05:00, West Asia (Islamabad)", "GMT+05:00, West Asia (Islamabad)" ], [ "GMT+05:30, India (Bombay)", "GMT+05:30, India (Bombay)" ], [ "GMT+06:00, Columbo (Columbo)", "GMT+06:00, Columbo (Columbo)" ], [ "GMT+06:00, Central Asia (Almaty)", "GMT+06:00, Central Asia (Almaty)" ], [ "GMT+07:00, Bangkok (Bangkok)", "GMT+07:00, Bangkok (Bangkok)" ], [ "GMT+08:00, China (Beijing)", "GMT+08:00, China (Beijing)" ], [ "GMT+08:00, Australia Western (Perth)", "GMT+08:00, Australia Western (Perth)" ], [ "GMT+08:00, Singapore (Singapore)", "GMT+08:00, Singapore (Singapore)" ], [ "GMT+08:00, Taipei (Hong Kong)", "GMT+08:00, Taipei (Hong Kong)" ], [ "GMT+09:00, Tokyo (Tokyo)", "GMT+09:00, Tokyo (Tokyo)" ], [ "GMT+09:00, Korea (Seoul)", "GMT+09:00, Korea (Seoul)" ], [ "GMT+09:30, Yakutsk (Yakutsk)", "GMT+09:30, Yakutsk (Yakutsk)" ], [ "GMT+09:30, Australia Central (Adelaide)", "GMT+09:30, Australia Central (Adelaide)" ], [ "GMT+09:30, Australia Central (Darwin)", "GMT+09:30, Australia Central (Darwin)" ], [ "GMT+10:00, Australia Eastern (Brisbane)", "GMT+10:00, Australia Eastern (Brisbane)" ], [ "GMT+10:00, Australia Eastern (Sydney)", "GMT+10:00, Australia Eastern (Sydney)" ], [ "GMT+10:00, West Pacific (Guam)", "GMT+10:00, West Pacific (Guam)" ], [ "GMT+10:00, Tasmania (Hobart)", "GMT+10:00, Tasmania (Hobart)" ], [ "GMT+10:00, Vladivostok (Vladivostok)", "GMT+10:00, Vladivostok (Vladivostok)" ], [ "GMT+11:00, Central Pacific (Solomon Is)", "GMT+11:00, Central Pacific (Solomon Is)" ], [ "GMT+12:00, New Zealand (Wellington)", "GMT+12:00, New Zealand (Wellington)" ], [ "GMT+12:00, Fiji (Fiji)", "GMT+12:00, Fiji (Fiji)" ], [ "GMT-09:00, Alaska (Anchorage)", "GMT-09:00, Alaska (Anchorage)" ] ], "maxItems": 1, "type": "string" }, "showFileInterVal": { "name": "showFileInterVal", "title": "Show File Inter Val", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "showFileContPlayFlag": { "name": "showFileContPlayFlag", "title": "Show File Cont Play Flag", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" } } }, "meetingkey": { "title": "Meetingkey", "minItems": 1, "required": true, "default": -1, "maxItems": 1, "type": "integer" }, "participantsJoined": { "minItems": 0, "required": false, "type": "boolean", "maxItems": 1, "title": "Participants Joined" }, "telephony": { "title": "Telephony", "minItems": 0, "required": false, "maxItems": 1, "type": "object", "properties": { "isMPAudio": { "name": "isMPAudio", "title": "Is MP Audio", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "callInNum": { "name": "callInNum", "title": "Call In Num", "minItems": 0, "required": false, "maxItems": 1, "type": "object", "properties": { "tollNum": { "name": "tollNum", "title": "Toll Num", "minItems": 1, "required": true, "maxItems": 1, "type": "string" }, "tollFreeNum": { "name": "tollFreeNum", "title": "Toll Free Num", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "intlLocalNum": { "name": "intlLocalNum", "title": "Intl Local Num", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "globalNum": { "name": "globalNum", "title": "Global Num", "minItems": 0, "items": { "type": "object", "properties": { "default": { "name": "default", "title": "Default", "minItems": 1, "required": true, "maxItems": 1, "type": "boolean" }, "phoneNumber": { "name": "phoneNumber", "title": "Phone Number", "minItems": 1, "required": true, "maxItems": 1, "type": "string" }, "tollFree": { "name": "tollFree", "title": "Toll Free", "minItems": 1, "required": true, "maxItems": 1, "type": "boolean" }, "countryAlias": { "name": "countryAlias", "title": "Country Alias", "minItems": 1, "required": true, "maxItems": 1, "type": "string" } } }, "required": false, "type": "array" } } }, "teleconfLocation": { "name": "teleconfLocation", "title": "Teleconf Location", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "numPhoneLines": { "name": "numPhoneLines", "title": "Num Phone Lines", "minItems": 0, "required": false, "default": 4, "maxItems": 1, "type": "integer" }, "personalAccountIndex": { "name": "personalAccountIndex", "title": "Personal Account Index", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "extTelephonyDescription": { "name": "extTelephonyDescription", "title": "Ext Telephony Description", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "telephonySupport": { "name": "telephonySupport", "title": "Telephony Support", "minItems": 0, "required": false, "choices": [ [ "NONE", "NONE" ], [ "CALLIN", "CALLIN" ], [ "CALLBACK", "CALLBACK" ], [ "OTHER", "OTHER" ] ], "default": "NONE", "maxItems": 1, "type": "string" }, "tspAccessCodeOrder": { "name": "tspAccessCodeOrder", "title": "Tsp Access Code Order", "minItems": 0, "required": false, "choices": [ [ "SUBSCRIBER_1ST", "SUBSCRIBER_1ST" ], [ "PARTICIPANT_1ST", "PARTICIPANT_1ST" ] ], "maxItems": 1, "type": "string" }, "intlLocalCallIn": { "name": "intlLocalCallIn", "title": "Intl Local Call In", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "tollFree": { "name": "tollFree", "title": "Toll Free", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "enableTSP": { "name": "enableTSP", "title": "Enable TSP", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "tspAccountIndex": { "name": "tspAccountIndex", "title": "Tsp Account Index", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "tspConference": { "name": "tspConference", "title": "Tsp Conference", "minItems": 0, "required": false, "maxItems": 1, "type": "object", "properties": { "tollCallInNumber": { "name": "tollCallInNumber", "title": "Toll Call In Number", "minItems": 1, "required": true, "maxItems": 1, "maxLength": 512, "type": "string" }, "tollFreeCallInNumber": { "name": "tollFreeCallInNumber", "title": "Toll Free Call In Number", "minItems": 1, "required": true, "maxItems": 1, "maxLength": 512, "type": "string" }, "participantAccessCode": { "name": "participantAccessCode", "title": "Participant Access Code", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 512, "type": "string" }, "subscriberAccessCode": { "name": "subscriberAccessCode", "title": "Subscriber Access Code", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 512, "type": "string" } } }, "extTelephonyURL": { "name": "extTelephonyURL", "title": "Ext Telephony URL", "minItems": 0, "required": false, "maxItems": 1, "type": "string" } } }, "participants": { "title": "Participants", "minItems": 0, "required": false, "maxItems": 1, "type": "object", "properties": { "maxUserNumber": { "name": "maxUserNumber", "title": "Max User Number", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "attendees": { "name": "attendees", "title": "Attendees", "minItems": 0, "required": false, "maxItems": 1, "type": "object", "properties": { "attendee": { "name": "attendee", "title": "Attendee", "minItems": 0, "items": { "type": "object", "properties": { "timeZoneID": { "name": "timeZoneID", "title": "Time Zone ID", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "language": { "name": "language", "title": "Language", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "languageID": { "name": "languageID", "title": "Language ID", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "locale": { "name": "locale", "title": "Locale", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "joinStatus": { "name": "joinStatus", "title": "Join Status", "minItems": 0, "required": false, "choices": [ [ "REGISTER", "REGISTER" ], [ "INVITE", "INVITE" ], [ "REJECT", "REJECT" ], [ "ACCEPT", "ACCEPT" ] ], "maxItems": 1, "type": "string" }, "contactID": { "name": "contactID", "title": "Contact ID", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "sessionNum": { "name": "sessionNum", "title": "Session Num", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "person": { "name": "person", "title": "Person", "minItems": 1, "required": true, "maxItems": 1, "type": "object", "properties": { "name": { "name": "name", "title": "Name", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "firstName": { "name": "firstName", "title": "First Name", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "title": { "name": "title", "title": "Title", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "url": { "name": "url", "title": "Url", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "lastName": { "name": "lastName", "title": "Last Name", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "company": { "name": "company", "title": "Company", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "webExId": { "name": "webExId", "title": "Web Ex Id", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "email": { "name": "email", "title": "Email", "minItems": 1, "required": true, "maxItems": 1, "type": "string" }, "address": { "name": "address", "title": "Address", "minItems": 0, "required": false, "maxItems": 1, "type": "object", "properties": { "city": { "name": "city", "title": "City", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "addressType": { "name": "addressType", "title": "Address Type", "minItems": 0, "required": false, "choices": [ [ "PERSONAL", "PERSONAL" ], [ "GLOBAL", "GLOBAL" ] ], "default": "PERSONAL", "maxItems": 1, "type": "string" }, "address1": { "name": "address1", "title": "Address1", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "address2": { "name": "address2", "title": "Address2", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "zipCode": { "name": "zipCode", "title": "Zip Code", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "state": { "name": "state", "title": "State", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "country": { "name": "country", "title": "Country", "minItems": 0, "required": false, "maxItems": 1, "type": "string" } } }, "phones": { "name": "phones", "title": "Phones", "minItems": 0, "required": false, "maxItems": 1, "type": "object", "properties": { "phone": { "name": "phone", "title": "Phone", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "fax": { "name": "fax", "title": "Fax", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "mobilePhone": { "name": "mobilePhone", "title": "Mobile Phone", "minItems": 0, "required": false, "maxItems": 1, "type": "string" } } }, "type": { "name": "type", "title": "Type", "minItems": 0, "required": false, "choices": [ [ "VISITOR", "VISITOR" ], [ "MEMBER", "MEMBER" ], [ "PANELIST", "PANELIST" ], [ "SME", "SME" ], [ "SALESTEAM", "SALESTEAM" ] ], "default": "VISITOR", "maxItems": 1, "type": "string" }, "notes": { "name": "notes", "title": "Notes", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "sendReminder": { "name": "sendReminder", "title": "Send Reminder", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" } } }, "meetingKey": { "name": "meetingKey", "title": "Meeting Key", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "sessionKey": { "name": "sessionKey", "title": "Session Key", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "role": { "name": "role", "title": "Role", "minItems": 0, "required": false, "choices": [ [ "ATTENDEE", "ATTENDEE" ], [ "PRESENTER", "PRESENTER" ], [ "HOST", "HOST" ], [ "LIMITED", "LIMITED" ] ], "maxItems": 1, "type": "string" }, "emailInvitations": { "name": "emailInvitations", "title": "Email Invitations", "minItems": 0, "required": false, "default": false, "maxItems": 1, "type": "boolean" } } }, "required": false, "type": "array" } } } } }, "tracking": { "title": "Tracking", "minItems": 0, "required": false, "maxItems": 1, "type": "object", "properties": { "trackingCode5": { "name": "trackingCode5", "title": "Tracking Code5", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 128, "type": "string" }, "trackingCode4": { "name": "trackingCode4", "title": "Tracking Code4", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 128, "type": "string" }, "trackingCode7": { "name": "trackingCode7", "title": "Tracking Code7", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 128, "type": "string" }, "trackingCode6": { "name": "trackingCode6", "title": "Tracking Code6", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 128, "type": "string" }, "trackingCode1": { "name": "trackingCode1", "title": "Tracking Code1", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 128, "type": "string" }, "trackingCode10": { "name": "trackingCode10", "title": "Tracking Code10", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 128, "type": "string" }, "trackingCode3": { "name": "trackingCode3", "title": "Tracking Code3", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 128, "type": "string" }, "trackingCode2": { "name": "trackingCode2", "title": "Tracking Code2", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 128, "type": "string" }, "trackingCode9": { "name": "trackingCode9", "title": "Tracking Code9", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 128, "type": "string" }, "trackingCode8": { "name": "trackingCode8", "title": "Tracking Code8", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 128, "type": "string" } } }, "enableOptions": { "title": "Enable Options", "minItems": 0, "required": false, "maxItems": 1, "type": "object", "properties": { "fullScreen": { "name": "fullScreen", "title": "Full Screen", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "rcWebTour": { "name": "rcWebTour", "title": "Rc Web Tour", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "attendeeRecordMeeting": { "name": "attendeeRecordMeeting", "title": "Attendee Record Meeting", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "supportUCFWebPages": { "name": "supportUCFWebPages", "title": "Support UCF Web Pages", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "allowContactPrivate": { "name": "allowContactPrivate", "title": "Allow Contact Private", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "closedCaptions": { "name": "closedCaptions", "title": "Closed Captions", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "chatAllAttendees": { "name": "chatAllAttendees", "title": "Chat All Attendees", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "chat": { "name": "chat", "title": "Chat", "minItems": 0, "required": false, "default": false, "maxItems": 1, "type": "boolean" }, "poll": { "name": "poll", "title": "Poll", "minItems": 0, "required": false, "default": false, "maxItems": 1, "type": "boolean" }, "pointer": { "name": "pointer", "title": "Pointer", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "desktopShare": { "name": "desktopShare", "title": "Desktop Share", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "rcAppShare": { "name": "rcAppShare", "title": "Rc App Share", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "printDocument": { "name": "printDocument", "title": "Print Document", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "HQvideo": { "name": "HQvideo", "title": "H Qvideo", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "fileShare": { "name": "fileShare", "title": "File Share", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "applicationShare": { "name": "applicationShare", "title": "Application Share", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "autoDeleteAfterMeetingEnd": { "name": "autoDeleteAfterMeetingEnd", "title": "Auto Delete After Meeting End", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "supportPKI": { "name": "supportPKI", "title": "Support PKI", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "supportFeedback": { "name": "supportFeedback", "title": "Support Feedback", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "attendeeList": { "name": "attendeeList", "title": "Attendee List", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "viewAnyDoc": { "name": "viewAnyDoc", "title": "View Any Doc", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "voip": { "name": "voip", "title": "Voip", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "rcDesktopShare": { "name": "rcDesktopShare", "title": "Rc Desktop Share", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "chatPresenter": { "name": "chatPresenter", "title": "Chat Presenter", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "presentation": { "name": "presentation", "title": "Presentation", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "thumbnail": { "name": "thumbnail", "title": "Thumbnail", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "multiVideo": { "name": "multiVideo", "title": "Multi Video", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "javaClient": { "name": "javaClient", "title": "Java Client", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "audioVideo": { "name": "audioVideo", "title": "Audio Video", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "supportBreakoutSessions": { "name": "supportBreakoutSessions", "title": "Support Breakout Sessions", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "supportPanelists": { "name": "supportPanelists", "title": "Support Panelists", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "saveDocument": { "name": "saveDocument", "title": "Save Document", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "displayQuickStartAttendees": { "name": "displayQuickStartAttendees", "title": "Display Quick Start Attendees", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "importDocument": { "name": "importDocument", "title": "Import Document", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "sendFeedback": { "name": "sendFeedback", "title": "Send Feedback", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "viewVideoThumbs": { "name": "viewVideoThumbs", "title": "View Video Thumbs", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "nativeClient": { "name": "nativeClient", "title": "Native Client", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "HDvideo": { "name": "HDvideo", "title": "H Dvideo", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "supportE2E": { "name": "supportE2E", "title": "Support E2E", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "switchPage": { "name": "switchPage", "title": "Switch Page", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "chatHost": { "name": "chatHost", "title": "Chat Host", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "displayQuickStartHost": { "name": "displayQuickStartHost", "title": "Display Quick Start Host", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "annotation": { "name": "annotation", "title": "Annotation", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "supportQandA": { "name": "supportQandA", "title": "Support Qand A", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "supportUCFRichMedia": { "name": "supportUCFRichMedia", "title": "Support UCF Rich Media", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "viewAnyPage": { "name": "viewAnyPage", "title": "View Any Page", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "notes": { "name": "notes", "title": "Notes", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "supportRemoteComputer": { "name": "supportRemoteComputer", "title": "Support Remote Computer", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "webTour": { "name": "webTour", "title": "Web Tour", "minItems": 0, "required": false, "default": false, "maxItems": 1, "type": "boolean" }, "copyPage": { "name": "copyPage", "title": "Copy Page", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "enableReg": { "name": "enableReg", "title": "Enable Reg", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "supportShareWebContent": { "name": "supportShareWebContent", "title": "Support Share Web Content", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "faxIntoMeeting": { "name": "faxIntoMeeting", "title": "Fax Into Meeting", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "meetingRecord": { "name": "meetingRecord", "title": "Meeting Record", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "singleNote": { "name": "singleNote", "title": "Single Note", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "zoom": { "name": "zoom", "title": "Zoom", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" } } }, "hostJoined": { "minItems": 0, "required": false, "type": "boolean", "maxItems": 1, "title": "Host Joined" }, "remind": { "title": "Remind", "minItems": 0, "required": false, "maxItems": 1, "type": "object", "properties": { "daysAhead": { "name": "daysAhead", "title": "Days Ahead", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "hoursAhead": { "name": "hoursAhead", "title": "Hours Ahead", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "sendEmail": { "name": "sendEmail", "title": "Send Email", "minItems": 0, "required": false, "default": false, "maxItems": 1, "type": "boolean" }, "mobile": { "name": "mobile", "title": "Mobile", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "enableReminder": { "name": "enableReminder", "title": "Enable Reminder", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "sendMobile": { "name": "sendMobile", "title": "Send Mobile", "minItems": 0, "required": false, "default": false, "maxItems": 1, "type": "boolean" }, "minutesAhead": { "name": "minutesAhead", "title": "Minutes Ahead", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "emails": { "name": "emails", "title": "Emails", "minItems": 0, "required": false, "maxItems": 1, "type": "object", "properties": { "email": { "name": "email", "title": "Email", "minItems": 0, "items": { "type": "string" }, "required": false, "type": "array" } } } } }, "attendeeOptions": { "title": "Attendee Options", "minItems": 0, "required": false, "maxItems": 1, "type": "object", "properties": { "excludePassword": { "name": "excludePassword", "title": "Exclude Password", "minItems": 0, "required": false, "default": false, "maxItems": 1, "type": "boolean" }, "auto": { "name": "auto", "title": "Auto", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "request": { "name": "request", "title": "Request", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "joinRequiresAccount": { "name": "joinRequiresAccount", "title": "Join Requires Account", "minItems": 0, "required": false, "default": false, "maxItems": 1, "type": "boolean" }, "participantLimit": { "name": "participantLimit", "title": "Participant Limit", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "registration": { "name": "registration", "title": "Registration", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "emailInvitations": { "name": "emailInvitations", "title": "Email Invitations", "minItems": 0, "required": false, "default": false, "maxItems": 1, "type": "boolean" } } }, "telePresence": { "minItems": 0, "required": false, "type": "boolean", "maxItems": 1, "title": "Tele Presence" }, "repeat": { "title": "Repeat", "minItems": 0, "required": false, "maxItems": 1, "type": "object", "properties": { "seriesMeetingKey": { "name": "seriesMeetingKey", "title": "Series Meeting Key", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "weekInMonth": { "name": "weekInMonth", "title": "Week In Month", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "isException": { "name": "isException", "title": "Is Exception", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "monthInYear": { "name": "monthInYear", "title": "Month In Year", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "dayInYear": { "name": "dayInYear", "title": "Day In Year", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "interval": { "name": "interval", "title": "Interval", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "expirationDate": { "name": "expirationDate", "title": "Expiration Date", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "dayInWeek": { "name": "dayInWeek", "title": "Day In Week", "minItems": 0, "required": false, "maxItems": 1, "type": "object", "properties": { "day": { "name": "day", "title": "Day", "minItems": 0, "items": { "type": "string", "choices": [ [ "SUNDAY", "SUNDAY" ], [ "MONDAY", "MONDAY" ], [ "TUESDAY", "TUESDAY" ], [ "WEDNESDAY", "WEDNESDAY" ], [ "THURSDAY", "THURSDAY" ], [ "FRIDAY", "FRIDAY" ], [ "SATURDAY", "SATURDAY" ] ] }, "required": false, "type": "array" } } }, "repeatType": { "name": "repeatType", "title": "Repeat Type", "minItems": 0, "required": false, "choices": [ [ "WEEKLY", "WEEKLY" ], [ "DAILY", "DAILY" ], [ "NO_REPEAT", "NO_REPEAT" ], [ "CONSTANT", "CONSTANT" ], [ "MONTHLY", "MONTHLY" ], [ "YEARLY", "YEARLY" ] ], "maxItems": 1, "type": "string" }, "afterMeetingNumber": { "name": "afterMeetingNumber", "title": "After Meeting Number", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "dayInMonth": { "name": "dayInMonth", "title": "Day In Month", "minItems": 0, "required": false, "maxItems": 1, "type": "integer" }, "hasException": { "name": "hasException", "title": "Has Exception", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" } } }, "metaData": { "title": "Meta Data", "minItems": 0, "required": false, "maxItems": 1, "type": "object", "properties": { "setNonMTOptions": { "name": "setNonMTOptions", "title": "Set Non MT Options", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "isInternal": { "name": "isInternal", "title": "Is Internal", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "greeting": { "name": "greeting", "title": "Greeting", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "confName": { "name": "confName", "title": "Conf Name", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "location": { "name": "location", "title": "Location", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "agenda": { "name": "agenda", "title": "Agenda", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 2500, "type": "string" }, "invitation": { "name": "invitation", "title": "Invitation", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "meetingType": { "name": "meetingType", "title": "Meeting Type", "minItems": 0, "required": false, "default": -1, "maxItems": 1, "type": "integer" }, "sessionTemplate": { "name": "sessionTemplate", "title": "Session Template", "minItems": 0, "required": false, "maxItems": 1, "type": "object", "properties": { "default": { "name": "default", "title": "Default", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "use": { "name": "use", "title": "Use", "minItems": 0, "required": false, "maxItems": 1, "type": "string" } } } } } }, "schema_version": "8.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/webex/Meeting/add/ |
|
The GUI Add form of device/webex/Meeting 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/device/webex/Meeting/ | 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/device/webex/Meeting/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/webex/Meeting/[pkid1]", "/api/device/webex/Meeting/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/webex/Meeting/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/webex/Meeting/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/webex/Meeting/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/webex/Meeting/[pkid1]", "/api/v0/device/webex/Meeting/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/webex/Meeting/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/webex/Meeting |
|
{"hrefs": ["/api/device/webex/Meeting/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/webex/Meeting |
|
{"hrefs": ["/api/device/webex/Meeting/[pkid1]", "/api/device/webex/Meeting/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/webex/Meeting; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/webex/Meeting/export/ |
|
{ "hrefs":["/api/device/webex/Meeting/[pkid1]", "/api/device/webex/Meeting/[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 device/webex/Meeting and the JSON format can be used to import instances of device/webex/Meeting.
GET http://[host-proxy]/api/device/webex/Meeting/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/webex/Meeting | POST | /api/device/webex/Meeting/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/device/webex/Meeting/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/webex/Meeting/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/webex/Meeting/ |
|
The device/webex/Meeting schema and all instances as JSON. |
(The list will return 0 to 3 device/webex/Meeting instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "clone", "move", "list", "update", "remove", "bulk_update_form", "add", "transform", "export", "export_bulkload_template" ], "pagination": { "direction": "asc", "order_by": "status", "maximum_limit": 2000, "skip": 0, "current": "/api/device/webex/Meeting/?skip=0&limit=3&order_by=status&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "8.0", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/device/webex/Meeting/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/webex/Meeting/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/webex/Meeting/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Bulk Modify" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/webex/Meeting", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/webex/Meeting/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/device/webex/Meeting/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/webex/Meeting/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/webex/Meeting/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/webex/Meeting/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/webex/Meeting/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/webex/Meeting/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/webex/Meeting", "model_specific_actions": [ "field_display_policy", "configuration_template", "help", "get", "clone", "move", "list", "update", "remove", "add", "export", "export_bulkload_template", "bulk_update_form" ], "summary_attrs": [ { "name": "status", "title": "Status" }, { "name": "hostJoined", "title": "Host Joined" }, { "name": "participantsJoined", "title": "Participants Joined" }, { "name": "telePresence", "title": "Tele Presence" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "20.1.1", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/webex/Meeting. | GET | /api/device/webex/Meeting/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/webex/Meeting as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/webex/Meeting/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/webex/Meeting/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/webex/Meeting/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/webex/Meeting/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/webex/Meeting | 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 device/webex/Meeting; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/webex/Meeting/[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 device/webex/Meeting and the JSON format can be used to import instances of device/webex/Meeting.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/webex/Meeting/[pkid]/ | hierarchy=[hierarchy] | The device/webex/Meeting instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/webex/Meeting/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/webex/Meeting. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/webex/Meeting/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |