Retrieve a milestone

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/milestones/wfm_9f8e7d6c5b4a43219f8e7d6c5b4a3210" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

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.milestones().getMilestone("wfm_9f8e7d6c5b4a43219f8e7d6c5b4a3210");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Milestones.GetMilestoneAsync("wfm_9f8e7d6c5b4a43219f8e7d6c5b4a3210");

Console.WriteLine(response.Json);

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.Milestones().GetMilestone(context.Background(), "wfm_9f8e7d6c5b4a43219f8e7d6c5b4a3210", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "milestone": {}
}

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

milestones

{milestone_uuid}

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/milestones/wfm_9f8e7d6c5b4a43219f8e7d6c5b4a3210" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

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.milestones().getMilestone("wfm_9f8e7d6c5b4a43219f8e7d6c5b4a3210");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Milestones.GetMilestoneAsync("wfm_9f8e7d6c5b4a43219f8e7d6c5b4a3210");

Console.WriteLine(response.Json);

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.Milestones().GetMilestone(context.Background(), "wfm_9f8e7d6c5b4a43219f8e7d6c5b4a3210", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "milestone": {}
}

{
  "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 milestone under milestone. A workflow’s milestone definition is a different record and returns 404 here.

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

milestone_uuid

string

required

The milestone's id, which starts with wfm_, or its UUID.

Response

The milestone, under milestone.

milestone

object

Guides

API reference

Authorizations

Path Parameters

Response