---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Flow -- Umfang (Veraltet)

# Flow -- Umfang (Veraltet) {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 Minuten Lesedauer

Die Flow API stellt Methoden zur Ausführung aktiviert bereit Workflow-StudioFlows.

Diese API ist veraltet und wird durch ersetzt [ScriptableFlowRunner -- Umfang](https://servicenow-prod.fluidtopics.net/N9zYXyk2FirKvqdvyusIug#ScriptableFlowRunnerScopedAPI "Erstellt ein Generatorobjekt, das zum Definieren von Parametern für die Flow-, Subflow- und Aktionsausführung verwendet wird. Sie können einen Flow angeben, der in einer bestimmten Domäne ausgeführt werden soll. Starten Sie die Flow-, Subflow- oder Aktionsausführung direkt über den Generator, und zeigen Sie die Ergebnisse in einem ScriptableFlowRunnerResult-Objekt an.")Und [ScriptableFlowRunnerResult -- Umfang](https://servicenow-prod.fluidtopics.net/39D~NEQcQ3oHtlq5aVMVfg#ScriptableFlowRunnerResultScopedAPI "Erfasst das Ergebnis der Verwendung ScriptableFlowRunner Dient zum Ausführen eines Flows, Subflows oder einer Aktion. Enthält Daten wie die Kontext-ID, die Domäne und alle Ausgaben aus der Flow-Ausführung.")APIs.

Die Flow API kann nur in Serverskripts verwendet werden.

Verwenden Sie `sn_fd `Namespace für den Zugriff auf Flow API.

Bevor mit einem Flow mit interagiert wird Flow API, müssen Sie zuerst den Flow in erstellen und aktivieren Workflow-StudioSchnittstelle. Weil Flow API interagiert nur mit vorgefertigten Flows, es gibt keinen Konstruktor für die Klasse.  
Hinweis:  
Um die Instanzleistung zu optimieren, vermeiden Sie es, diese Methoden aus einem asynchronen Business-Regelskript aufzurufen. Erstellen Sie stattdessen einen Datensatz für eine geplante Aufgabe in Workflow-StudioUI.

## Flow -- startAsync(Zeichenfolge scope Name.flowName, Zuordnungs-flowInputs) {#ariaid-title2}

Ignoriert den Auslöser und führt einen aktivierten Flow asynchron aus.
Asynchrone Aufrufe blockieren nicht, sodass der Client anderen Code im Skript ausführen kann, ohne auf Abschluss des Flows warten zu müssen.
{#FlowScoped-startAsync_S_GR__table_s1t_yn5_ncb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Scope-Name.flowName | Zeichenfolge | Der Anwendungsbereich für den Flow und der interne Name des auszuführenden Flows. Wenn „scope Name" nicht enthalten ist, wird der Umfang des derzeit angemeldeten Anwenders verwendet. Rufen Sie den internen Namen des Flows mit ab Interner Name Spalte auf Workflow-StudioZielseite. |
| FlowEingaben | Karte | Name-Wert-Paare in `<String, Object> `Format, das datensatzbasierte Flow-Eingaben definiert. Verwenden Sie das folgende Format, um einen Flow mit einem datensatzbasierten Auslöser aufzurufen: var flowInputs = {}; flowInputs['current'] = glideRecord; flowInputs['table_name'] = glideRecord.getTableName(); Das GlideRecord-Objekt muss den Namen „current" haben. Dient zum Aufrufen eines Flows mit ServicekatalogAuslöser, verwenden Sie das folgende Format: var flowInputs = {}; flowInputs['request_item'] = glideRecord; flowInputs['table_name'] = glideRecord.getTableName(); Das GlideRecord-Objekt muss den Namen „Request_item" haben. |
[Tabelle : 1. Parameter]

{#FlowScoped-startAsync_S_GR__table_s1t_yn5_ncb} {#FlowScoped-startAsync_S_GR__table_t1t_yn5_ncb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | PlanResponse-Objekt mit den folgenden Eigenschaften: * ContextID: sys_ID des Ausführungsdetails-Datensatzes für den ausgeführten Flow. Greifen Sie auf die Ausführungsdetails zu, indem Sie zur Registerkarte „Flow-Ausführungen" in navigieren Workflow-StudioUnd wird nach sys_ID gefiltert {#FlowScoped-startAsync_S_GR__ul_bd2_k2v_ncb} Eine Ausnahme tritt auf, wenn der Flow: * Ist innerhalb des angegebenen Anwendungsbereichs nicht vorhanden, oder der Flow- oder Bereichsname wurde falsch geschrieben. * Ist nicht aktiviert. * Überschreitet das von festgelegte Rekursionslimit com.glide.hub.flow_engine.indirect_recursion_limitSystemeigenschaft. Der Standardwert ist drei. {#FlowScoped-startAsync_S_GR__ul_ub3_n3t_pcb} |
[Tabelle : 2. Rückgaben]

{#FlowScoped-startAsync_S_GR__table_t1t_yn5_ncb}  

    //Example 1: Run a flow with a record-based trigger
    (function startFlowAsync() {

    	try {
    		// You MUST fetch the GlideRecord that will be passed to the flow
    		var glideRecordInput = new GlideRecord('sys_user');
    		glideRecordInput.get('62826bf03710200044e0bfc8bcbe5df1');

    		var flowInputs = {};
    		flowInputs['current'] = glideRecordInput;
    		flowInputs['table_name'] = glideRecordInput.getTableName();

    		var result = sn_fd.Flow.startAsync('global.recordtriggeredflow', flowInputs);

    		//The Sys ID of a flow execution (contextId)
    		var contextId = result.contextId;

    	} catch (ex) {
    		var message = ex.getMessage();
    		gs.error(message);
    	}

    })();

    //Example 2: Run a flow with a schedule-based trigger
    (function startFlowAsync() {

    	try {
    		var result = sn_fd.Flow.startAsync('global.scheduletriggeredflow');

    		//The Sys ID of a flow execution (contextId)
    		var contextId = result.contextId;

    	} catch (ex) {
    		var message = ex.getMessage();
    		gs.error(message);
    	}

    })();

    //Example 3: Run a flow with a Service Catalog trigger
    (function startFlowAsync() {

    	try {
    		// You MUST fetch the GlideRecord that will be passed to the flow
    		var glideRecordInput = new GlideRecord('sc_req_item');
    		glideRecordInput.get(aeed229047801200e0ef563dbb9a71c2);

    		var flowInputs = {};
    		flowInputs['request_item'] = glideRecordInput;
    		flowInputs['table_name'] = glideRecordInput.getTableName();

    		var result = sn_fd.Flow.startAsync('global.catalogtriggeredflow', flowInputs);

    		//The Sys ID of a flow execution (contextId)
    		var contextId = result.contextId;

    	} catch (ex) {
    		var message = ex.getMessage();
    		gs.error(message);
    	}

    })();

    //Example 4: Run a flow with a MetricBase trigger
    (function startMetricBaseFlowAsync() {

    	try {

    		var oilLevelTriggerRecord = new GlideRecord('oil_levels');
    		oilLevelTriggerRecord.get('a4b3622bc72113007b237f48cb97635f');

    		var metricTriggerDefinition = new GlideRecord('sys_metric_trigger_definition');
    		metricTriggerDefinition.get('21f2eae7c72113007b237f48cb976352');

    		var event_time = oilLevelTriggerRecord.getValue('sys_created_on');
    		var level = 4;

    		var metricBaseFlowInputs = {};
    		//The record that triggered the metric event
    		metricBaseFlowInputs['current'] = oilLevelTriggerRecord;
    		//The MetricBase Trigger Definition record
    		metricBaseFlowInputs['metric'] = metricTriggerDefinition;
    		//The time that the 'record' reached a specific metric event level and triggered this flow
    		metricBaseFlowInputs['event_time'] = event_time;
    		//The target event level to reach in order for a metric flow to trigger
    		metricBaseFlowInputs['level'] = level;

    		var result = sn_fd.Flow.startAsync('global.metricbasedtriggeredflow', metricBaseFlowInputs);

    		//The Sys ID of a flow execution (contextId)
    		var contextId = result.contextId;

    	} catch (ex) {
    		var message = ex.getMessage();
    		gs.error(message);
    	}

    })();


