Korzystaj z operacji zapisu, aktualizacji i usuwania portali Web API

Można wykonać Dostępne operacje interfejsu API sieci Web w portalach. Operacje interfejsu API sieci Web składają się z żądań i odpowiedzi HTTP. Ten artykuł zawiera przykładowe operacje zapisu, aktualizacji i usuwania, metody, identyfikator URI i przykładowy kod JSON, których można używać w żądaniach HTTP.

Wymagania wstępne

• Włącz tabelę i pole dla operacji interfejsu API sieci Web. Więcej informacji: Ustawienia witryny dla internetowego interfejsu API

• Internetowy interfejs API portali uzyskuje dostęp do rekordów tabel i postępuje zgodnie z uprawnieniami do tabel przyznanymi użytkownikom za pośrednictwem skojarzonych ról internetowych. Upewnij się, że skonfigurowano poprawne uprawnienia do tabeli. Więcej informacji: Tworzenie ról internetowych

Utwórz rekord w tabeli

Tworzenie podstawowe

Przykładowy kod JSON tworzenia rekordów tabeli pokrewnej w jednej operacji

Na przykład następująca treść żądania opublikowana w zestawie tabel Konta utworzy w sumie cztery nowe tabele — w tym konto — w kontekście tworzenia konta.

• Kontakt jest tworzony, ponieważ jest zdefiniowany jako właściwość obiektu jednowartościowej właściwości nawigacji primarycontactid.
• Szansa sprzedaży jest tworzona, ponieważ jest zdefiniowana jako obiekt w tablicy, która jest ustawiona na wartość właściwości nawigacji o wartości kolekcji opportunity_customer_accounts.
• Zadanie jest tworzone, ponieważ jest zdefiniowane jako obiekt w tablicy, która jest ustawiona na wartość właściwości nawigacji o wartości kolekcji 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" }
      ]
  }
 ]
}

Kojarzenie rekordów tabeli przy tworzeniu

Przykładowy kod JSON polegający na utworzeniu adnotacji za pośrednictwem internetowego interfejsu 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 będzie zawierać załącznik w postaci ciągu Base64.

Aktualizowanie i usuwanie rekordów za pomocą interfejsu API sieci Web

Podstawowa aktualizacja

Aktualizowanie pojedynczej wartości właściwości

Usuwanie lub usuwanie wartości pola

Usuwanie podstawowe

Skojarz i rozłącz tabele za pomocą internetowego interfejsu API

Dodaj odwołanie do właściwości nawigacji o wartości kolekcji

Usuwanie odwołania do tabeli

Usuwanie odwołania do tabeli dla jedno valued właściwości nawigacji

Aby uzyskać jednowartościową właściwość nawigacji, Usuń parametr ciągu zapytania $id.

Zmiana odwołania w jednowartościowej właściwości nawigacji

Kojarzenie tabeli przy tworzeniu

Korzystając z funkcji deep insert, można relacje nowe tabele.

Kojarzenie tabel podczas aktualizacji przy użyciu jedno valued właściwości nawigacji

Tabele dotyczące aktualizacji można skojarzyć, korzystając z tego samego komunikatu opisanego w aktualizacji podstawowej — wcześniej w tym temat, ale do ustawienia wartości jednowartościowej właściwości nawigacji należy użyć adnotacji @odata.bind. Poniższy przykład zmienia konto skojarzone z szansą sprzedaży przy użyciu jednowartościowej właściwości nawigacji customerid_account.

Kojarzenie tabel podczas aktualizacji przy użyciu jedno valued właściwości nawigacji

Przykłady AJAX internetowego interfejsu API

W tym przykładzie pokazano, jak tworzyć, aktualizować i usuwać rekordy tabel za pomocą języka JavaScript asynchronicznego i języka XML (XML).

Funkcja otoki 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)

Utworzenie

	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"))
		}
	});

Zaktualizuj

  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);
		}
  });

Utwórz skojarzenie

Poniższy przykład przypisze istniejący kontakt jako główny kontakt dla istniejącego konta.

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");
    }
});

Następny krok

Samouczek: Używanie internetowego interfejsu API portali

Informacje pokrewne

• Omówienie interfejsu API sieci Web
  
• Odczytuje operacje przy użyciu internetowego interfejsu API