---
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


---

# GlideFlow -- Client

# GlideFlow -- Client {#ariaid-title1}

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

Die GlideFlow Die API bietet Methoden für clientseitige Interaktionen mit Aktionen, Flows und Subflows.

Sie können diese API an beliebiger Stelle in der Plattform verwenden, die Client-Skripts akzeptiert. Die Aktion, der Flow oder der Subflow müssen als vom Client aufrufbar festgelegt werden und über eine gültige ACL verfügen, die die Funktion „Sicherheit verwalten" in verwendet Workflow-Studio.

Einige der Methoden in GlideFlow API-Rückgabe `Versprechen `Objekte. A `Versprechen `Stellt das letztendliche Ergebnis eines asynchronen Vorgangs dar. Weitere Informationen zu Zusagen finden Sie unter [Zusage: JavaScript-MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)Oder [AngularJS-Dokumentation](https://docs.angularjs.org/api/ng/service/$q).  
Mit dieser API können Sie:

* Starten Sie Aktionen, Flows oder Subflows über ein Skript.
* Ruft eine vorhandene Ausführung ab.
* Ruft den Status und alle verfügbaren Ausgaben ab.
* Warten Sie auf den Abschluss einer Aktion, eines Flows oder eines Subflows.
{#GlideFlowAPI__ul_bdk_tf2_xs}

Es ist kein Konstruktor für vorhanden GlideFlow API. Zugriff GlideFlow Methoden, die verwenden `GlideFlow `Globales Objekt.

## GlideFlow -- Execution.awaitCompletion() {#ariaid-title2}

Gibt ein Abschlussobjekt für die Ausführung zurück.
{#execution-awaitCompletion__table_bqv_1q2_ffb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 1. Parameter]

{#execution-awaitCompletion__table_bqv_1q2_ffb} {#execution-awaitCompletion__table_cqv_1q2_ffb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Ein Objekt, das Abschlussdetails für eine Flow- oder Aktionsausführung enthält. |
[Tabelle : 2. Rückgaben]

{#execution-awaitCompletion__table_cqv_1q2_ffb}  
In diesem Beispiel wird eine Aktion mit startAction() ausgeführt, die ein Ausführungsobjekt zurückgibt. Der Code verwendet dann awaitCompletion() für dieses Ausführungsobjekt, das ein Abschlussobjekt zurückgibt. Der Code verwendet dieses Abschlussobjekt, um den Status und die Ausgaben innerhalb der Ausführung zu protokollieren.


    (function() {
    	var inputs = {};

    	inputs['input1'] = 'string input'; // String

    	GlideFlow.startAction('global.action_name', inputs)
    		.then(function(execution) {
    			return execution.awaitCompletion();
    		}, errorResolver)
    		.then(function(completion) {
    			var status = completion.status;
    			console.log(status);

    			// Available Outputs:
    			var outputs = completion.outputs;
    			console.log(outputs);
    		}, errorResolver());

    	function errorResolver(error) {
    		// Handle errors in error resolver
    		console.error(error);
    	}
    })();

## GlideFlow -- Execution.getExecutionStatus() {#ariaid-title3}

Gibt eine Zeichenfolge zurück, die den Ausführungsstatus der aktuellen Ausführung enthält.
{#execution-getExecutionStatus__table_utm_jp2_ffb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 3. Parameter]

{#execution-getExecutionStatus__table_utm_jp2_ffb} {#execution-getExecutionStatus__table_vtm_jp2_ffb__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Eine Zeichenfolge, die den Ausführungsstatus enthält. |
[Tabelle : 4. Rückgaben]

{#execution-getExecutionStatus__table_vtm_jp2_ffb}  
In diesem Beispiel ruft der Code ein Ausführungsobjekt mit der Methode „getExecution" ab. Die Methode „getExecution" erfordert eine ID, die von der zum Starten der Ausführung verwendeten Methode zurückgegeben wird. Der Code verwendet dann getExecutionStatus(), um zu bestimmen, ob die Ausführung abgeschlossen wurde, bevor er fortfährt.


    // Get an existing action, getStatus, and getOutputs if complete
    (function() {
       GlideFlow.getExecution('mamIN4Q35vmEFe744EwJV5GHrSz8fmJG')
          .then(function(execution) {
             execution.getExecutionStatus().then(
                function(status) {
                   if (status === 'COMPLETE')
                      execution.getOutputs().then(
                         function(outputs) {
                            console.log(outputs);
                         },
                         errorResolver
                      );
                },
                errorResolver
             );
          }, errorResolver);

       function errorResolver(error) {
          // Handle errors in error resolver
          console.error(error);
       }
    })();

## GlideFlow -- Execution.getOutputs() {#ariaid-title4}

Gibt ein Ausgabeobjekt für die Ausführung zurück.
Verwenden Sie diese Methode, um auf die Ausgabe zuzugreifen, die durch die Ausführung einer Aktion, eines Flows oder eines Subflows generiert wird.
{#execution-getOutputs__table_jsw_f42_ffb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 5. Parameter]

{#execution-getOutputs__table_jsw_f42_ffb} {#execution-getOutputs__table_ksw_f42_ffb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Ein Objekt, das Ausgaben für eine Aktion, einen Flow oder einen Subflow enthält. |
[Tabelle : 6. Rückgaben]

{#execution-getOutputs__table_ksw_f42_ffb}  
In diesem Beispiel ruft der Code ein Ausführungsobjekt mit der Methode „getExecution" ab. Nachdem die Ausführung abgeschlossen ist, verwendet der Code getOutputs(), um ein Ausgabeobjekt zurückzugeben, das er dann mit der Methode console.log protokolliert.


    // Get an existing action, getStatus, and getOutputs if complete
    (function() {
       GlideFlow.getExecution('mamIN4Q35vmEFe744EwJV5GHrSz8fmJG')
          .then(function(execution) {
             execution.getExecutionStatus().then(
                function(status) {
                   if (status === 'COMPLETE')
                      execution.getOutputs().then(
                         function(outputs) {
                            console.log(outputs);
                         },
                         errorResolver
                      );
                },
                errorResolver
             );
          }, errorResolver);

       function errorResolver(error) {
          // Handle errors in error resolver
          console.error(error);
       }
    })();

## GlideFlow -- getExecution(Zeichenfolge executionId) {#ariaid-title5}

Ruft eine vorhandene Ausführungsinstanz nach ID ab.
{#GlideFlow-getExecution__table_hpx_tqd_ffb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| executionId | Zeichenfolge | Die ID der abzurufenden Ausführung. |
[Tabelle : 7. Parameter]

{#GlideFlow-getExecution__table_hpx_tqd_ffb} {#GlideFlow-getExecution__table_ipx_tqd_ffb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Eine Zusage eines Ausführungsobjekts. |
[Tabelle : 8. Rückgaben]

{#GlideFlow-getExecution__table_ipx_tqd_ffb}  
In diesem Beispiel ruft der Code eine Ausführung ab und wartet dann auf den Abschluss, bevor der Abschlussstatus und die Ausgaben der Ausführungen mit „Console.log" protokolliert werden.


    // Get an existing action and await completion
    (function() {
    	GlideFlow.getExecution('79cd437e0b202300a150a95e93673ae3')
    		.then(function(execution) {
    			return execution.awaitCompletion();
    		}, errorResolver)
    		.then(function(completion) {

    			var status = completion.status;
    			console.log(status);

    			// Available Outputs:
    			var outputs = completion.outputs;
    			console.log(outputs);
    		}, errorResolver());

    	function errorResolver(error) {
    		// Handle errors in error resolver
    		console.error(error);
    	}
    })();

## GlideFlow -- startAction(Zeichenfolge scopedName.actionName, Zuordnungseingaben) {#ariaid-title6}

Starten Sie eine Aktion.
{#GlideFlow-startAction__table_q1w_r4d_ffb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| scopedName | Zeichenfolge | Der bereichsbezogene Name des auszuführenden Flows. |
| inputs | Objekt | Ein Objekt mit Eingaben, die für die Aktion definiert sind. |
[Tabelle : 9. Parameter]

{#GlideFlow-startAction__table_q1w_r4d_ffb} {#GlideFlow-startAction__table_r1w_r4d_ffb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Ein Objekt mit Details zur Aktionsausführung. |
[Tabelle : 10. Rückgaben]

{#GlideFlow-startAction__table_r1w_r4d_ffb}  
In diesem Beispiel startet der Code die globale Aktion „action_Name" mithilfe von Argumenten in der Eingabeobjektvariablen. Nach Abschluss verwendet das Beispiel console.log oder Console.error, um den Erfolg oder Fehler des Flows zu melden.


    // Start an action and await completion.
    (function() {
    	var inputs = {};

    	inputs['input1'] = 'string input'; // String

    	GlideFlow.startAction('global.action_name', inputs)
    		.then(function(execution) {
    			return execution.awaitCompletion();
    		}, errorResolver)
    		.then(function(completion) {
    			var status = completion.status;
    			console.log(status);

    			// Available Outputs:
    			var outputs = completion.outputs;
    			console.log(outputs);
    		}, errorResolver());

    	function errorResolver(error) {
    		// Handle errors in error resolver
    		console.error(error);
    	}
    })();

## GlideFlow -- startFlow(Zeichenfolge scope edName.flowName, Zuordnungseingaben) {#ariaid-title7}

Starten Sie einen Flow.
{#GlideFlow-startFlow__table_jl5_xqc_ffb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| scopedName | Zeichenfolge | Der bereichsbezogene Name des auszuführenden Flows. |
| inputs | Objekt | Ein Objekt mit Eingaben, die für den Flow definiert sind. |
[Tabelle : 11. Parameter]

{#GlideFlow-startFlow__table_jl5_xqc_ffb} {#GlideFlow-startFlow__table_kl5_xqc_ffb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Ein Objekt mit Details zur Flow-Ausführung. |
[Tabelle : 12. Rückgaben]

{#GlideFlow-startFlow__table_kl5_xqc_ffb}  
Dieser Beispiel-Flow wird normalerweise ausgelöst, wenn ein Datensatz in der Incident-Tabelle aktualisiert wird. Da Sie den Flow aus dem Clientskript aktivieren, müssen Sie diese Informationen angeben. Der Code erstellt eine Eingabevariable, die den aktuellen Datensatz und die Tabelle für den Datensatz enthält


    // Start a Flow
    (function() {
          var inputs = {};
          inputs['current'] = { // GlideRecord 
            table : 'incident', 
            sys_id : '79cd437e0b202300a150a95e93673ae3'  
        };
            inputs['table_name'] = 'incident';
             GlideFlow.startFlow('global.flow_name', inputs)
    		.then(
    			function(execution) {
    				console.log('Started flow_name with execution id :' + execution.getExecutionId());
    			},
    			function(error) {
    				console.log('Unable to start flow: ' + error);
    			}
    		);
    })();

## GlideFlow -- startSubflow(Zeichenfolge scopedName.subflowName, Zuordnungseingaben) {#ariaid-title8}

Starten Sie einen Subflow.
{#GlideFlow-startSubflow__table_ftt_5pd_ffb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| scopedName | Zeichenfolge | Der bereichsbezogene Name des auszuführenden Flows. |
| inputs | Objekt | Ein Objekt mit Eingaben, die für den Subflow verwendet werden. |
[Tabelle : 13. Parameter]

{#GlideFlow-startSubflow__table_ftt_5pd_ffb} {#GlideFlow-startSubflow__table_gtt_5pd_ffb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Ein Objekt mit Details zur Subflow-Ausführung. |
[Tabelle : 14. Rückgaben]

{#GlideFlow-startSubflow__table_gtt_5pd_ffb}  
In diesem Beispiel startet der Code den globalen Subflow „Subflow_Name" mithilfe von Argumenten in der Array-Variablen „Eingaben". Nach Abschluss verwendet das Beispiel console.log oder Console.error, um den Erfolg oder Fehler des Flows zu melden.


    // Start an action and await completion.
    (function() {
    	var inputs = {};

    	inputs['input1'] = 'string input'; // String

    	GlideFlow.startSubflow('global.subflow_name', inputs)
    		.then(function(execution) {
    			return execution.awaitCompletion();
    		}, errorResolver)
    		.then(function(completion) {
    			var status = completion.status;
    			console.log(status);

    			// Available Outputs:
    			var outputs = completion.outputs;
    			console.log(outputs);
    		}, errorResolver());

    	function errorResolver(error) {
    		// Handle errors in error resolver
    		console.error(error);
    	}
    })();


