[Index]
Model ref.: relation/UserMS365MigrateRel
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": {
"ObjectId": {
"name": "ObjectId",
"type": "string",
"title": "Object ID",
"required": false,
"readonly": true
},
"UserPrincipalName": {
"name": "UserPrincipalName",
"type": "string",
"title": "User Principal Name",
"readonly": true
},
"City": {
"name": "City",
"type": "string",
"title": "City",
"readonly": true
},
"DisplayLicenses": {
"name": "DisplayLicenses",
"type": "string",
"title": "Licenses Summary",
"readonly": true
},
"DisplayName": {
"name": "DisplayName",
"type": "string",
"title": "Display Name",
"readonly": true
},
"FirstName": {
"name": "FirstName",
"type": "string",
"title": "First Name",
"readonly": true
},
"Title": {
"name": "Title",
"type": "string",
"title": "Title",
"readonly": true
},
"LastName": {
"name": "LastName",
"type": "string",
"title": "Last Name",
"readonly": true
},
"PostalCode": {
"name": "PostalCode",
"type": "string",
"title": "Postal Code",
"readonly": true
},
"Department": {
"name": "Department",
"type": "string",
"title": "Department",
"readonly": true
},
"UsageLocation": {
"name": "UsageLocation",
"type": "string",
"title": "Usage Location",
"description": "Country code, eg. US",
"choices": [
{
"value": "AF",
"title": "Afghanistan"
},
{
"value": "AX",
"title": "\u00c5land Islands"
},
{
"value": "AL",
"title": "Albania"
},
{
"value": "DZ",
"title": "Algeria"
},
{
"value": "AS",
"title": "American Samoa"
},
{
"value": "AD",
"title": "Andorra"
},
{
"value": "AO",
"title": "Angola"
},
{
"value": "AI",
"title": "Anguilla"
},
{
"value": "AQ",
"title": "Antarctica"
},
{
"value": "AG",
"title": "Antigua and Barbuda"
},
{
"value": "AR",
"title": "Argentina"
},
{
"value": "AM",
"title": "Armenia"
},
{
"value": "AW",
"title": "Aruba"
},
{
"value": "AU",
"title": "Australia"
},
{
"value": "AT",
"title": "Austria"
},
{
"value": "AZ",
"title": "Azerbaijan"
},
{
"value": "BS",
"title": "Bahamas, The"
},
{
"value": "BH",
"title": "Bahrain"
},
{
"value": "BD",
"title": "Bangladesh"
},
{
"value": "BB",
"title": "Barbados"
},
{
"value": "BY",
"title": "Belarus"
},
{
"value": "BE",
"title": "Belgium"
},
{
"value": "BZ",
"title": "Belize"
},
{
"value": "BJ",
"title": "Benin"
},
{
"value": "BM",
"title": "Bermuda"
},
{
"value": "BT",
"title": "Bhutan"
},
{
"value": "BT",
"title": "Bolivia"
},
{
"value": "BO",
"title": "Bonaire, Saint Eustatius and Saba"
},
{
"value": "BA",
"title": "Bosnia and Herzegovina"
},
{
"value": "BW",
"title": "Botswana"
},
{
"value": "BV",
"title": "Bouvet Island"
},
{
"value": "BR",
"title": "Brazil"
},
{
"value": "IO",
"title": "British Indian Ocean Territory"
},
{
"value": "IO",
"title": "Brunei"
},
{
"value": "BG",
"title": "Bulgaria"
},
{
"value": "BF",
"title": "Burkina Faso"
},
{
"value": "BI",
"title": "Burundi"
},
{
"value": "CV",
"title": "Cabo Verde"
},
{
"value": "KH",
"title": "Cambodia"
},
{
"value": "CM",
"title": "Cameroon"
},
{
"value": "CA",
"title": "Canada"
},
{
"value": "KY",
"title": "Cayman Islands"
},
{
"value": "CF",
"title": "Central African Republic"
},
{
"value": "TD",
"title": "Chad"
},
{
"value": "CL",
"title": "Chile"
},
{
"value": "CN",
"title": "China"
},
{
"value": "CX",
"title": "Christmas Island"
},
{
"value": "CC",
"title": "Cocos (Keeling) Islands"
},
{
"value": "CO",
"title": "Colombia"
},
{
"value": "KM",
"title": "Comoros"
},
{
"value": "CG",
"title": "Congo"
},
{
"value": "CG",
"title": "Congo (DRC)"
},
{
"value": "CK",
"title": "Cook Islands"
},
{
"value": "CR",
"title": "Costa Rica"
},
{
"value": "CR",
"title": "C\u00f4te d\u2019Ivoire"
},
{
"value": "HR",
"title": "Croatia"
},
{
"value": "CW",
"title": "Cura\u00e7ao"
},
{
"value": "CY",
"title": "Cyprus"
},
{
"value": "CY",
"title": "Czech Republic"
},
{
"value": "DK",
"title": "Denmark"
},
{
"value": "DJ",
"title": "Djibouti"
},
{
"value": "DM",
"title": "Dominica"
},
{
"value": "DO",
"title": "Dominican Republic"
},
{
"value": "EC",
"title": "Ecuador"
},
{
"value": "EG",
"title": "Egypt"
},
{
"value": "SV",
"title": "El Salvador"
},
{
"value": "GQ",
"title": "Equatorial Guinea"
},
{
"value": "ER",
"title": "Eritrea"
},
{
"value": "EE",
"title": "Estonia"
},
{
"value": "ET",
"title": "Ethiopia"
},
{
"value": "ET",
"title": "Falkland Islands (Islas Malvinas)"
},
{
"value": "FO",
"title": "Faroe Islands"
},
{
"value": "FJ",
"title": "Fiji Islands"
},
{
"value": "FI",
"title": "Finland"
},
{
"value": "FR",
"title": "France"
},
{
"value": "GF",
"title": "French Guiana"
},
{
"value": "PF",
"title": "French Polynesia"
},
{
"value": "PF",
"title": "French Southern and Antarctic Lands"
},
{
"value": "GA",
"title": "Gabon"
},
{
"value": "GM",
"title": "Gambia, The"
},
{
"value": "GE",
"title": "Georgia"
},
{
"value": "DE",
"title": "Germany"
},
{
"value": "GH",
"title": "Ghana"
},
{
"value": "GI",
"title": "Gibraltar"
},
{
"value": "GR",
"title": "Greece"
},
{
"value": "GL",
"title": "Greenland"
},
{
"value": "GD",
"title": "Grenada"
},
{
"value": "GP",
"title": "Guadeloupe"
},
{
"value": "GU",
"title": "Guam"
},
{
"value": "GT",
"title": "Guatemala"
},
{
"value": "GG",
"title": "Guernsey"
},
{
"value": "GN",
"title": "Guinea"
},
{
"value": "GW",
"title": "Guinea-Bissau"
},
{
"value": "GY",
"title": "Guyana"
},
{
"value": "HT",
"title": "Haiti"
},
{
"value": "HM",
"title": "Heard Island and McDonald Islands"
},
{
"value": "VA",
"title": "Holy See (Vatican City State)"
},
{
"value": "HN",
"title": "Honduras"
},
{
"value": "HK",
"title": "Hong Kong SAR"
},
{
"value": "HU",
"title": "Hungary"
},
{
"value": "IS",
"title": "Iceland"
},
{
"value": "IN",
"title": "India"
},
{
"value": "ID",
"title": "Indonesia"
},
{
"value": "IQ",
"title": "Iraq"
},
{
"value": "IE",
"title": "Ireland"
},
{
"value": "IM",
"title": "Isle of Man"
},
{
"value": "IL",
"title": "Israel"
},
{
"value": "IT",
"title": "Italy"
},
{
"value": "JM",
"title": "Jamaica"
},
{
"value": "JP",
"title": "Japan"
},
{
"value": "JE",
"title": "Jersey"
},
{
"value": "JO",
"title": "Jordan"
},
{
"value": "KZ",
"title": "Kazakhstan"
},
{
"value": "KE",
"title": "Kenya"
},
{
"value": "KI",
"title": "Kiribati"
},
{
"value": "KR",
"title": "Korea, Republic of"
},
{
"value": "KW",
"title": "Kuwait"
},
{
"value": "KG",
"title": "Kyrgyzstan"
},
{
"value": "LA",
"title": "Laos"
},
{
"value": "LV",
"title": "Latvia"
},
{
"value": "LB",
"title": "Lebanon"
},
{
"value": "LS",
"title": "Lesotho"
},
{
"value": "LR",
"title": "Liberia"
},
{
"value": "LY",
"title": "Libya"
},
{
"value": "LI",
"title": "Liechtenstein"
},
{
"value": "LT",
"title": "Lithuania"
},
{
"value": "LU",
"title": "Luxembourg"
},
{
"value": "MO",
"title": "Macao SAR"
},
{
"value": "MO",
"title": "Macedonia, Former Yugoslav Republic of"
},
{
"value": "MG",
"title": "Madagascar"
},
{
"value": "MW",
"title": "Malawi"
},
{
"value": "MY",
"title": "Malaysia"
},
{
"value": "MV",
"title": "Maldives"
},
{
"value": "ML",
"title": "Mali"
},
{
"value": "MT",
"title": "Malta"
},
{
"value": "MH",
"title": "Marshall Islands"
},
{
"value": "MQ",
"title": "Martinique"
},
{
"value": "MR",
"title": "Mauritania"
},
{
"value": "MU",
"title": "Mauritius"
},
{
"value": "YT",
"title": "Mayotte"
},
{
"value": "MX",
"title": "Mexico"
},
{
"value": "MX",
"title": "Micronesia"
},
{
"value": "FM",
"title": "Moldova"
},
{
"value": "MC",
"title": "Monaco"
},
{
"value": "MN",
"title": "Mongolia"
},
{
"value": "ME",
"title": "Montenegro"
},
{
"value": "MS",
"title": "Montserrat"
},
{
"value": "MA",
"title": "Morocco"
},
{
"value": "MZ",
"title": "Mozambique"
},
{
"value": "MM",
"title": "Myanmar"
},
{
"value": "NA",
"title": "Namibia"
},
{
"value": "NR",
"title": "Nauru"
},
{
"value": "NP",
"title": "Nepal"
},
{
"value": "NP",
"title": "Netherlands"
},
{
"value": "NP",
"title": "Netherlands Antilles (Former)"
},
{
"value": "NC",
"title": "New Caledonia"
},
{
"value": "NZ",
"title": "New Zealand"
},
{
"value": "NI",
"title": "Nicaragua"
},
{
"value": "NE",
"title": "Niger"
},
{
"value": "NG",
"title": "Nigeria"
},
{
"value": "NU",
"title": "Niue"
},
{
"value": "NF",
"title": "Norfolk Island"
},
{
"value": "MP",
"title": "Northern Mariana Islands"
},
{
"value": "NO",
"title": "Norway"
},
{
"value": "OM",
"title": "Oman"
},
{
"value": "PK",
"title": "Pakistan"
},
{
"value": "PW",
"title": "Palau"
},
{
"value": "PS",
"title": "Palestinian Authority"
},
{
"value": "PA",
"title": "Panama"
},
{
"value": "PG",
"title": "Papua New Guinea"
},
{
"value": "PY",
"title": "Paraguay"
},
{
"value": "PE",
"title": "Peru"
},
{
"value": "PH",
"title": "Philippines"
},
{
"value": "PN",
"title": "Pitcairn Islands"
},
{
"value": "PL",
"title": "Poland"
},
{
"value": "PT",
"title": "Portugal"
},
{
"value": "PR",
"title": "Puerto Rico"
},
{
"value": "QA",
"title": "Qatar"
},
{
"value": "QA",
"title": "Reunion"
},
{
"value": "RO",
"title": "Romania"
},
{
"value": "RO",
"title": "Russia"
},
{
"value": "RW",
"title": "Rwanda"
},
{
"value": "BL",
"title": "Saint Barth\u00e9lemy"
},
{
"value": "SH",
"title": "Saint Helena, Ascension and Tristan da Cunha"
},
{
"value": "KN",
"title": "Saint Kitts and Nevis"
},
{
"value": "LC",
"title": "Saint Lucia"
},
{
"value": "LC",
"title": "Saint Martin"
},
{
"value": "PM",
"title": "Saint Pierre and Miquelon"
},
{
"value": "VC",
"title": "Saint Vincent and the Grenadines"
},
{
"value": "WS",
"title": "Samoa"
},
{
"value": "SM",
"title": "San Marino"
},
{
"value": "ST",
"title": "S\u00e3o Tom\u00e9 and Pr\u00edncipe"
},
{
"value": "SA",
"title": "Saudi Arabia"
},
{
"value": "SN",
"title": "Senegal"
},
{
"value": "RS",
"title": "Serbia"
},
{
"value": "SC",
"title": "Seychelles"
},
{
"value": "SL",
"title": "Sierra Leone"
},
{
"value": "SG",
"title": "Singapore"
},
{
"value": "SG",
"title": "Sint Maarten"
},
{
"value": "SK",
"title": "Slovakia"
},
{
"value": "SI",
"title": "Slovenia"
},
{
"value": "SB",
"title": "Solomon Islands"
},
{
"value": "SO",
"title": "Somalia"
},
{
"value": "ZA",
"title": "South Africa"
},
{
"value": "GS",
"title": "South Georgia and the South Sandwich Islands"
},
{
"value": "SS",
"title": "South Sudan"
},
{
"value": "ES",
"title": "Spain"
},
{
"value": "LK",
"title": "Sri Lanka"
},
{
"value": "SR",
"title": "Suriname"
},
{
"value": "SJ",
"title": "Svalbard and Jan Mayen Island"
},
{
"value": "SZ",
"title": "Swaziland"
},
{
"value": "SE",
"title": "Sweden"
},
{
"value": "CH",
"title": "Switzerland"
},
{
"value": "SY",
"title": "Taiwan"
},
{
"value": "TJ",
"title": "Tajikistan"
},
{
"value": "TJ",
"title": "Tanzania"
},
{
"value": "TH",
"title": "Thailand"
},
{
"value": "TL",
"title": "Timor-Leste"
},
{
"value": "TG",
"title": "Togo"
},
{
"value": "TK",
"title": "Tokelau"
},
{
"value": "TO",
"title": "Tonga"
},
{
"value": "TT",
"title": "Trinidad and Tobago"
},
{
"value": "TN",
"title": "Tunisia"
},
{
"value": "TR",
"title": "Turkey"
},
{
"value": "TM",
"title": "Turkmenistan"
},
{
"value": "TC",
"title": "Turks and Caicos Islands"
},
{
"value": "TV",
"title": "Tuvalu"
},
{
"value": "TV",
"title": "U.S. Minor Outlying Islands"
},
{
"value": "UG",
"title": "Uganda"
},
{
"value": "UA",
"title": "Ukraine"
},
{
"value": "AE",
"title": "United Arab Emirates"
},
{
"value": "GB",
"title": "United Kingdom"
},
{
"value": "US",
"title": "United States"
},
{
"value": "UY",
"title": "Uruguay"
},
{
"value": "UZ",
"title": "Uzbekistan"
},
{
"value": "VU",
"title": "Vanuatu"
},
{
"value": "VU",
"title": "Venezuela"
},
{
"value": "VN",
"title": "Vietnam"
},
{
"value": "VG",
"title": "Virgin Islands, British"
},
{
"value": "VI",
"title": "Virgin Islands, U.S."
},
{
"value": "WF",
"title": "Wallis and Futuna"
},
{
"value": "EH",
"title": "Western Sahara"
},
{
"value": "YE",
"title": "Yemen"
},
{
"value": "ZM",
"title": "Zambia"
},
{
"value": "ZW",
"title": "Zimbabwe"
}
]
},
"Country": {
"name": "Country",
"type": "string",
"title": "Country",
"readonly": true
},
"StreetAddress": {
"name": "StreetAddress",
"type": "string",
"title": "Street Address",
"readonly": true
},
"PhoneNumber": {
"name": "PhoneNumber",
"type": "string",
"title": "Phone Number",
"readonly": true
},
"MobilePhone": {
"name": "Mobile Phone",
"type": "string",
"title": "Mobile Phone",
"readonly": true
},
"Office": {
"name": "Office",
"type": "string",
"title": "Office",
"readonly": true
},
"State": {
"name": "State",
"type": "string",
"title": "State",
"readonly": true
},
"ProxyAddresses": {
"name": "ProxyAddresses",
"type": "array",
"title": "Proxy Addresses",
"items": {
"type": "string",
"readonly": true
},
"readonly": true
},
"IsLicensed": {
"name": "IsLicensed",
"type": "string",
"title": "Is Licensed",
"readonly": true,
"choices": [
{
"title": "True",
"value": "true"
},
{
"title": "False",
"value": "false"
}
]
},
"Licenses": {
"name": "Licenses",
"type": "array",
"title": "Licenses",
"items": {
"type": "object",
"properties": {
"ServicePlans": {
"name": "ServicePlans",
"type": "array",
"title": "Service Plans",
"items": {
"type": "object",
"properties": {
"ServicePlanId": {
"name": "ServicePlanId",
"type": "string",
"title": "Service Plan ID",
"readonly": true
},
"ServiceName": {
"name": "ServiceName",
"type": "string",
"title": "Service Name",
"readonly": true
},
"Enabled": {
"name": "Enabled",
"type": "boolean",
"title": "Enabled"
}
}
}
},
"AccountSkuId": {
"name": "AccountSkuId",
"type": "string",
"title": "SKU Part Number",
"format": "uri",
"target": "/api/device/msgraph/MsolAccountSku/choices/?field=SkuPartNumber&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "SkuPartNumber",
"target_model_type": "device/msgraph/MsolAccountSku",
"choices": []
},
"SkuId": {
"name": "SkuId",
"type": "string",
"title": "SKU ID",
"readonly": true
}
}
}
},
"Groups": {
"name": "Groups",
"type": "array",
"title": "Groups (INTERNAL USE ONLY)",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"items": {
"type": "object",
"properties": {
"displayName": {
"name": "displayName",
"type": "string",
"title": "Display Name",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"readonly": true
},
"id": {
"name": "id",
"type": "string",
"title": "Id",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"readonly": true
}
}
}
},
"LicenseAssignmentState": {
"name": "LicenseAssignmentState",
"type": "object",
"title": "License Assignment State (INTERNAL USE ONLY)",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"properties": {
"LicenseAssignmentStates": {
"name": "LicenseAssignmentStates",
"type": "array",
"title": "License Assignment States",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"items": {
"type": "object",
"properties": {
"disabledPlans": {
"name": "disabledPlans",
"type": "array",
"title": "Disabled Plans",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"items": {
"type": "string",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows."
},
"readonly": true
},
"skuId": {
"name": "SkuId",
"type": "string",
"title": "SKU ID",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"readonly": true
},
"assignedByGroup": {
"name": "assignedByGroup",
"type": "string",
"title": "Assigned By Group",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"readonly": true
},
"state": {
"name": "state",
"type": "string",
"title": "State",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"readonly": true
},
"error": {
"name": "error",
"type": "string",
"title": "Error",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"readonly": true
},
"lastUpdatedDateTime": {
"name": "lastUpdatedDateTime",
"type": "string",
"title": "Last Updated Date Time",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"readonly": true
}
}
}
},
"LicenseType": {
"name": "LicenseType",
"type": "string",
"title": "License Type",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"readonly": true
}
}
},
"extensionAttribute1": {
"name": "extensionAttribute1",
"type": "string",
"title": "Extension Attribute 1",
"description": "Extension Attribute 1",
"readonly": true
},
"extensionAttribute2": {
"name": "extensionAttribute2",
"type": "string",
"title": "Extension Attribute 2",
"description": "Extension Attribute 2",
"readonly": true
},
"extensionAttribute3": {
"name": "extensionAttribute3",
"type": "string",
"title": "Extension Attribute 3",
"description": "Extension Attribute 3",
"readonly": true
},
"extensionAttribute4": {
"name": "extensionAttribute4",
"type": "string",
"title": "Extension Attribute 4",
"description": "Extension Attribute 4",
"readonly": true
},
"extensionAttribute5": {
"name": "extensionAttribute5",
"type": "string",
"title": "Extension Attribute 5",
"description": "Extension Attribute 5",
"readonly": true
},
"extensionAttribute6": {
"name": "extensionAttribute6",
"type": "string",
"title": "Extension Attribute 6",
"description": "Extension Attribute 6",
"readonly": true
},
"extensionAttribute7": {
"name": "extensionAttribute7",
"type": "string",
"title": "Extension Attribute 7",
"description": "Extension Attribute 7",
"readonly": true
},
"extensionAttribute8": {
"name": "extensionAttribute8",
"type": "string",
"title": "Extension Attribute 8",
"description": "Extension Attribute 8",
"readonly": true
},
"extensionAttribute9": {
"name": "extensionAttribute9",
"type": "string",
"title": "Extension Attribute 9",
"description": "Extension Attribute 9",
"readonly": true
},
"extensionAttribute10": {
"name": "extensionAttribute10",
"type": "string",
"title": "Extension Attribute 10",
"description": "Extension Attribute 10",
"readonly": true
},
"extensionAttribute11": {
"name": "extensionAttribute11",
"type": "string",
"title": "Extension Attribute 11",
"description": "Extension Attribute 11",
"readonly": true
},
"extensionAttribute12": {
"name": "extensionAttribute12",
"type": "string",
"title": "Extension Attribute 12",
"description": "Extension Attribute 12",
"readonly": true
},
"extensionAttribute13": {
"name": "extensionAttribute13",
"type": "string",
"title": "Extension Attribute 13",
"description": "Extension Attribute 13",
"readonly": true
},
"extensionAttribute14": {
"name": "extensionAttribute14",
"type": "string",
"title": "Extension Attribute 14",
"description": "Extension Attribute 14",
"readonly": true
},
"extensionAttribute15": {
"name": "extensionAttribute15",
"type": "string",
"title": "Extension Attribute 15",
"description": "Extension Attribute 15",
"readonly": true
},
"noinstance": {
"title": "Noinstance",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"maxItems": 1
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/UserMS365MigrateRel/add/ |
|
The GUI Add form of relation/UserMS365MigrateRel 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/relation/UserMS365MigrateRel | 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/relation/UserMS365MigrateRel/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/UserMS365MigrateRel/[pkid1]", "/api/relation/UserMS365MigrateRel/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/UserMS365MigrateRel/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/UserMS365MigrateRel; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/UserMS365MigrateRel/export/ |
|
{ "hrefs":["/api/relation/UserMS365MigrateRel/[pkid1]", "/api/relation/UserMS365MigrateRel/[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/UserMS365MigrateRel and the JSON format can be used to import instances of relation/UserMS365MigrateRel.
GET http://[host-proxy]/api/relation/UserMS365MigrateRel/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/UserMS365MigrateRel | POST | /api/relation/UserMS365MigrateRel/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/relation/UserMS365MigrateRel/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/relation/UserMS365MigrateRel/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/UserMS365MigrateRel/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/UserMS365MigrateRel/ |
|
The relation/UserMS365MigrateRel schema and all instances as JSON. |
(The list will return 0 to 3 relation/UserMS365MigrateRel instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "UserPrincipalName",
"direction": "asc",
"current": "/api/relation/UserMS365MigrateRel/?skip=0&limit=3&order_by=UserPrincipalName&direction=asc&traversal=down"
},
"operations": [
"bulk_update",
"help",
"update",
"add",
"export",
"export_bulkload_template",
"get",
"list",
"tag",
"remove",
"configuration_template",
"field_display_policy"
],
"meta": {
"model_type": "relation/UserMS365MigrateRel",
"summary_attrs": [
{
"name": "UserPrincipalName",
"title": "User Principal Name"
},
{
"name": "FirstName",
"title": "First Name"
},
{
"name": "LastName",
"title": "Last Name"
},
{
"name": "IsLicensed",
"title": "Is Licensed"
},
{
"name": "DisplayLicenses",
"title": "Licenses Summary"
},
{
"name": "Department",
"title": "Department"
},
{
"name": "City",
"title": "City"
},
{
"name": "Country",
"title": "Country"
},
{
"name": "PhoneNumber",
"title": "Phone Number"
},
{
"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/UserMS365MigrateRel/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"update",
"add",
"export",
"get",
"export_bulkload_template",
"list",
"tag",
"remove",
"configuration_template",
"field_display_policy"
],
"schema_version": null,
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/UserMS365MigrateRel/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/UserMS365MigrateRel/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/UserMS365MigrateRel/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/UserMS365MigrateRel/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/relation/UserMS365MigrateRel/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/relation/UserMS365MigrateRel/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/relation/UserMS365MigrateRel/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/UserMS365MigrateRel/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/UserMS365MigrateRel/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/UserMS365MigrateRel/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/UserMS365MigrateRel; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/UserMS365MigrateRel/[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/UserMS365MigrateRel and the JSON format can be used to import instances of relation/UserMS365MigrateRel.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/relation/UserMS365MigrateRel/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/UserMS365MigrateRel/[pkid] | hierarchy=[hierarchy] | The relation/UserMS365MigrateRel instance with [pkid]. |