Musterschreiben unterlagen anfordern

Die REST-Client-API enthält Schnittstellen, mit denen Sie mehrere Dokumente in einer einzigen Anforderung lesen oder schreiben können. Sie können Dokumente für einen Massenlesemithilfe mithilfe einer Liste von URIs oder einer Abfrage auswählen. III: Dokumentation von API-Endpunkten: Die Referenzdokumentation für API-Endpunkte besteht aus fünf allgemeinen Abschnitten: Ressourcenbeschreibungen, Endpunkte und -methoden, Parameter, Beispielanforderungen sowie Beispielantworten und -schemas. Um die Referenzendpunkte einer API zu dokumentieren, geben Sie detaillierte Informationen für jeden dieser Abschnitte an. Die Ressourcen-URL enthält sowohl den Basispfad als auch den Endpunkt. Ein Problem beim Anzeigen der vollständigen Ressourcen-URL besteht darin, dass nicht angegeben wird, ob Headerinformationen übergeben werden müssen, um die Anforderung zu autorisieren. (Wenn Ihre API nur aus GET-Anforderungen besteht und keine Autorisierung erfordert, werden großartige, aber nur wenige APIs auf diese Weise eingerichtet.) curl-Anforderungen können problemlos beliebige Headerparameter anzeigen. Wenn ein Shard nicht auf eine Leseanforderung reagiert, sendet der koordinierende Knoten die Anforderung an eine andere Shardkopie in derselben Replikationsgruppe. Wiederholte Fehler können dazu führen, dass keine Shardkopien verfügbar sind. Der mehrteilige Text einer Massenschreibanforderung stellt einen Stream von Dokumentmetadaten und/oder -inhalten dar. Jedes Teil enthält entweder Inhalt oder Metadaten. Der Anforderungstext verfügt über die folgenden Hauptmerkmale: Das Zuordnen einer Umgebung zu Ihrer Dokumentation bedeutet, dass die Werte aller Umgebungsvariablen, auf die Ihre Anforderungsreferenz verweist, automatisch in den Dokumentinhalt auffüllen. Jeder, der die Schaltfläche “Run in Postman” aus Ihren Dokumenten verwendet, kann auch auf die freigegebene Umgebung zugreifen, wenn er die Sammlung in Postman importiert.

Da die Metadaten in der Beispielanforderung nur Einstellungen für Sammlungen-Metadaten enthalten, verwenden andere Metadatenkategorien wie Berechtigungen und Qualität die Systemstandardeinstellungen. Ein Beispiel für komplexere Metadaten finden Sie unter Erweitern des Beispiels. Das XML-Dokument verwendet die Systemstandardmetadaten, da dem Dokumentteil keine dokumentspezifischen oder Anforderungsstandardmetadaten vorangestellt sind. Das JSON-Dokument verwendet die dokumentspezifischen Metadaten, die in der Anforderung enthalten sind. Sie können die Anforderung in Shell (curl), Ruby, Node oder Python anzeigen. Entwickler können den benötigten Code einfach in ihre Anwendungen kopieren, anstatt herauszufinden, wie die Curl-Anforderung in eine bestimmte Programmiersprache übersetzt werden kann. curl ist ein gängiges Format, um Anfragen aus mehreren Gründen anzuzeigen: Bei der Anforderung der Materialien ist es wichtig, dem Archivpersonal eine spezifische Beschreibung der Materialien zu geben, die Sie sich ansehen möchten. Es gibt drei Hauptteile einer Beschreibung, die Sie in Ihre Anforderung für Materialien aufnehmen sollten: den Titel der Sammlung, die eindeutige Kennung sowie Die Feld- und Ordnernummern.