Restart Workflow with Rest API V2

• Description
• Authentication
• Using the Endpoint
• Path and Method
• Request Properties
• Response
• Success
• Failure
• Usage
• Since
• Source Code

Description

This endpoint allows you to restart the workflow for an existing entry.

Authentication

For available methods to authenticate to the API, refer to our REST API v2 Authentication guide.

The capability gravityflow_admin_actions is required to use POST requests at this endpoint.
This can be filtered using gravityflow_rest_api_capability_restart_workflow

Using the Endpoint

Path and Method

POST /wp-json/gf/v2/entries/[entry_id]/workflows/restart

The path must include the specific entry ID that you wish to restart the workflow for.

Request Properties

There are no required or optional properties for this endpoint.

Response

Success

A successful response will contain a JSON Workflow Status object that confirms the workflow restart operation was completed and the new current active step (if appropriate).

Failure

A failed response will provide a JSON string of the error code and message.

There are several failure scenarios which could be returned depending on request data provided.

Usage

PHP Request

//Update these variables
$entry_id = '1729';
$domain   = 'https://develop.local';
$auth_value = 'Basic replace-me-with-basic-auth-based-on-user-application-password';

// {@see https://codex.wordpress.org/HTTP_API}
$response = wp_remote_post( $domain . '/wp-json/gf/v2/entries/' . $entry_id . '/workflow/restart', array(
    'headers' => array(
        'Authorization' => $auth_value,
    ),
) );

if ( ! is_wp_error( $response ) ) {
    // The request went through successfully, check the response code against
    // what we're expecting
    if ( 200 == wp_remote_retrieve_response_code( $response ) ) {
        // Do something with the response
        // $body = wp_remote_retrieve_body( $response );
        // $headers = wp_remote_retrieve_headers( $response );
    } else {
        // The response code was not what we were expecting, record the message
        $error_message = wp_remote_retrieve_response_message( $response );
    }
} else {
    // There was an error making the request
    $error_message = $response->get_error_message();
}

Since

This endpoint was added in Gravity Flow 3.0.

Source Code

This endpoint is located in the gravityflow/includes/rest-api/v2/ folder with most of the route code in the class-controller-workflows.php file.