Používanie webového rozhrania API na portáloch na operácie zápisu, aktualizácie a odstránenia

Môžete realizovať dostupné operácie webového API na portáloch. Webové operácie API pozostávajú z požiadaviek HTTP a odpovedí. Tento článok poskytuje vzorové operácie zápisu, aktualizácie a odstraňovania, metódy, identifikátor URI a vzorový JSON, ktoré môžete použiť v požiadavkách HTTP.

Požiadavky

• Povoľte tabuľku a pole pre operácie webového rozhrania API. Ďalšie informácie: Nastavenia lokality pre webové rozhranie API

• Webové rozhranie API portálov pristupuje k záznamom tabuľky a riadi sa povoleniami tabuľky, ktoré dostali používatelia prostredníctvom pridružených webových rol. Uistite sa, že ste nakonfigurovali správne povolenia tabuľky. Ďalšie informácie: Vytváranie webových rolí

Vytvorenie záznamu v tabuľke

Základné vytvorenie

Vzorový súbor JSON na vytváranie súvisiacich záznamov tabuľky v jednej operácii

Napríklad nasledujúci text žiadosti zverejnený do množiny tabuliek Obchodný vzťah vytvorí celkovo štyri nové tabuľky – vrátane obchodného vzťahu – v rámci vytvárania obchodného vzťahu.

• Kontakt sa vytvorí, pretože je definovaný ako vlastnosť objektu navigačnej vlastnosti s jednou hodnotou primarycontactid.
• Príležitosť sa vytvára, pretože je definovaná ako objekt v poli, ktoré je nastavené na hodnotu navigačnej vlastnosti s hodnotou opportunity_customer_accounts.
• Úloha sa vytvára, pretože je definovaná ako objekt v poli, ktoré je nastavené na hodnotu navigačnej vlastnosti s hodnotou Opportunity_Tasks.

{
 "name": "Sample Account",
 "primarycontactid":
 {
     "firstname": "Alton",
     "lastname": "Stott"
 },
 "opportunity_customer_accounts":
 [
  {
      "name": "Opportunity associated to Sample Account",
      "Opportunity_Tasks":
      [
       { "subject": "Task associated to opportunity" }
      ]
  }
 ]
}

Priradenie záznamov tabuliek pri vytváraní

Ukážkový súbor JSON na vytváranie anotácií pomocou webového rozhrania API

{
    "new_attribute1": "test attribute 1",
    "new_attribute2": "test attribute 2",
    "new_comments": "test comments",
    "new_recordurl": recordURL,
    "new_feedback_Annotations":
        [
            {
                "notetext": "Screenshot attached",
                "subject": "Attachment",
                "filename": file.name,
                "mimetype": file.type,
                "documentbody": base64str,
            }
        ]
    }

documentbody bude obsahovať prílohu ako reťazec base64.

Aktualizujte a odstraňujte záznamy pomocou webového rozhrania API

Základná aktualizácia

Aktualizujte jednu hodnotu vlastnosti

Odstráňte alebo vymažte hodnotu poľa

Základné odstránenie

Priraďovanie a zrušenie priraďovania tabuliek pomocou webového rozhrania API

Pridajte odkaz na navigačnú vlastnosť s hodnotou kolekcie

Odstraňovanie odkazu na tabuľku

Odstráňte odkaz na tabuľku pre vlastnosť navigácie s jednou hodnotou

V prípade navigačnej vlastnosti s jednou hodnotou odstráňte parameter $id reťazca dopytu.

Zmeňte referenciu vo vlastnostiach navigácie s jednou hodnotou

Priradenie tabuliek pri vytváraní

Nové tabuľky je možné vytvoriť so vzťahmi pomocou hlbokého vloženia.

Priraďte tabuľky k aktualizácii pomocou vlastnosti navigácie s jednou hodnotou

K aktualizácii môžete priradiť tabuľky pomocou rovnakej správy popísanej v časti Základná aktualizácia skôr v tejto téme, ale musíte použiť anotáciu @odata.bind na nastavenie hodnoty vlastnosti navigácie s jednou hodnotou. Nasledujúci príklad zmení obchodný vzťah spojený s príležitosťou pomocou navigačnej vlastnosti customerid_account s jednou hodnotou.

Priraďte tabuľky k aktualizácii pomocou vlastnosti navigácie s jednou hodnotou

Ukážky webovej API AJAX

Táto ukážka demonštruje, ako vytvoriť, aktualizovať a odstrániť záznamy tabuľky pomocou asynchrónneho kódu JavaScript a XML (AJAX).

Funkcia Wrapper AJAX

	(function(webapi, $){
		function safeAjax(ajaxOptions) {
			var deferredAjax = $.Deferred();
	
			shell.getTokenDeferred().done(function (token) {
				// add headers for AJAX
				if (!ajaxOptions.headers) {
					$.extend(ajaxOptions, {
						headers: {
							"__RequestVerificationToken": token
						}
					}); 
				} else {
					ajaxOptions.headers["__RequestVerificationToken"] = token;
				}
				$.ajax(ajaxOptions)
					.done(function(data, textStatus, jqXHR) {
						validateLoginSession(data, textStatus, jqXHR, deferredAjax.resolve);
					}).fail(deferredAjax.reject); //AJAX
			}).fail(function () {
				deferredAjax.rejectWith(this, arguments); // on token failure pass the token AJAX and args
			});
	
			return deferredAjax.promise();	
		}
		webapi.safeAjax = safeAjax;
	})(window.webapi = window.webapi || {}, jQuery)

Vytvoriť

	webapi.safeAjax({
		type: "POST",
		url: "/_api/accounts",
		contentType: "application/json",
		data: JSON.stringify({
			"name": "Sample Account"
		}),
		success: function (res, status, xhr) {
      //print id of newly created table record
			console.log("entityID: "+ xhr.getResponseHeader("entityid"))
		}
	});

Update

  webapi.safeAjax({
    type: "PATCH",
    url: "/_api/accounts(00000000-0000-0000-0000-000000000001)",
    contentType: "application/json",
    data: JSON.stringify({
      "name": "Sample Account - Updated"
    }),
    success: function (res) {
      console.log(res);
    }
  });

Delete

	webapi.safeAjax({
		type: "DELETE",
		url: "/_api/accounts(00000000-0000-0000-0000-000000000001)",
		contentType: "application/json",
		success: function (res) {
			console.log(res);
		}
  });

Priradené

Nasledujúci príklad priradí existujúci kontakt ako primárny kontakt pre existujúci účet.

var record = {};
record[primarycontactid@odata.bind] = "/contacts(00000000-0000-0000-0000-000000000002)"; 

webapi.safeAjax({
  type: "PATCH",
  contentType: "application/json",
  url: "/_api/accounts(00000000-0000-0000-0000-000000000001)",
  data: JSON.stringify(record),
    success: function (data, textStatus, xhr) {
      console.log("Record updated");
    }
});

Ďalší krok

Ako na to: Použite portálové webové rozhranie API

Súvisiace informácie

• Prehľad webového rozhrania API
  
• Operácie čítania pomocou webového rozhrania API