Retrieve a component instance's milestone

Retrieves one workflow milestone of a custom component instance, by its wfmi_ id.

GET /workflows/custom_components/{component_uuid}/{object_code}/milestones/{milestone_id}

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/workflows/custom_components/7a1b3c5d-9e2f-4a6b-8c0d-1e3f5a7b9c2d/CC-1001/milestones/wfmi_5e7a9c1b3d4f4e6a8b0c2d4e6f8a0b1c" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

404

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

Identify the component by its dashed uuid and the instance by its code. Returns the milestone under workflow_milestone_instance. A milestone id that does not exist 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

component_uuid · string · required

The component's dashed uuid: the hex of its cmp_ id with the dashes put back. The cmp_ id itself returns 404.

object_code · string · required

The component instance's code, not its cco_ id.

milestone_id · string · required

The instance milestone's wfmi_ id.

Response

200

The milestone, under workflow_milestone_instance.