Retrieve a workflow stage

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/workflows/wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b/stages/wfs_2b7e4d1c9a8f4e3b8c6d5a4f3e2d1c0b" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.workflows.get_workflow_stage(
    "wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b", "wfs_2b7e4d1c9a8f4e3b8c6d5a4f3e2d1c0b"
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.workflows.getWorkflowStage(
    'wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b',
    'wfs_2b7e4d1c9a8f4e3b8c6d5a4f3e2d1c0b',
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->workflows->getWorkflowStage(
    'wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b',
    'wfs_2b7e4d1c9a8f4e3b8c6d5a4f3e2d1c0b',
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.workflows().getWorkflowStage(
        "wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b",
        "wfs_2b7e4d1c9a8f4e3b8c6d5a4f3e2d1c0b");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Workflows.GetWorkflowStageAsync(
    "wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b",
    "wfs_2b7e4d1c9a8f4e3b8c6d5a4f3e2d1c0b");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.workflows.getWorkflowStage(
  'wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b',
  'wfs_2b7e4d1c9a8f4e3b8c6d5a4f3e2d1c0b',
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Workflows().GetWorkflowStage(context.Background(), "wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b", "wfs_2b7e4d1c9a8f4e3b8c6d5a4f3e2d1c0b", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

GET

workflows

{workflow_id}

stages

{stage_id}

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/workflows/wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b/stages/wfs_2b7e4d1c9a8f4e3b8c6d5a4f3e2d1c0b" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.workflows.get_workflow_stage(
    "wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b", "wfs_2b7e4d1c9a8f4e3b8c6d5a4f3e2d1c0b"
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.workflows.getWorkflowStage(
    'wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b',
    'wfs_2b7e4d1c9a8f4e3b8c6d5a4f3e2d1c0b',
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->workflows->getWorkflowStage(
    'wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b',
    'wfs_2b7e4d1c9a8f4e3b8c6d5a4f3e2d1c0b',
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.workflows().getWorkflowStage(
        "wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b",
        "wfs_2b7e4d1c9a8f4e3b8c6d5a4f3e2d1c0b");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Workflows.GetWorkflowStageAsync(
    "wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b",
    "wfs_2b7e4d1c9a8f4e3b8c6d5a4f3e2d1c0b");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.workflows.getWorkflowStage(
  'wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b',
  'wfs_2b7e4d1c9a8f4e3b8c6d5a4f3e2d1c0b',
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Workflows().GetWorkflowStage(context.Background(), "wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b", "wfs_2b7e4d1c9a8f4e3b8c6d5a4f3e2d1c0b", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

Returns the stage under workflow_stage. A stage id the workflow does not hold returns 404 with the code resource_not_found.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

workflow_id

string

required

The workflow's wf_ id.

stage_id

string

required

The stage's wfs_ id.

Response

The stage, under workflow_stage.

Guides

API reference

Authorizations

Path Parameters

Response