---
title: "Get work definition information"
method: GET
path: "/work-definitions/{id}"
tags: ["Inspect", "Definitions"]
---

# Get work definition information

`GET /work-definitions/{id}`

## Request

- Base URL: `http://localhost:8090/inspect-api`
- URL: `http://localhost:8090/inspect-api/work-definitions/{id}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/flowable/apis/flowable-inspect-rest-api/docs/work-definitions/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `processInstanceId` string, required

## Query parameters

- `detailed` boolean

## Response `200`

Indicates the work definition information was found and returned.

- WorkDefinitionInfoDTO
  - `id` string, required: The unique id
  - `key` string, required: The key of the definition
  - `version` integer, required: The version of the definition
  - `name` string: Definition name
  - `category` string: Definition category
  - `description` string: Definition description
  - `type` string, required: Definition type
  - `appName` string: App name
  - `appKey` string: App key
  - `appIcon` string: App icon
  - `appOrder` integer: App order
  - `appColor` string: App color
  - `translations` object: The translations for the work definition. Map having locale as the key and key value pairs for each locale.
  - `appTranslations` object: The translations for the app definition. Map having locale as the key and key value pairs for each locale.
  - `numberOfVersions` integer
  - `roles` InstanceRoleDTO[]
    - `type` string
    - `userId` string
    - `userName` string
    - `groupKey` string
    - `groupName` string

## Other responses

- `403`: Indicates the user does not have the rights to query for the work definition.
- `404`: Indicates the requested work definition was not found.

---

[API](https://skmtc.dev/flowable/apis/flowable-inspect-rest-api.md) - [All operations](https://skmtc.dev/flowable/apis/flowable-inspect-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/flowable/apis/flowable-inspect-rest-api/revisions/5c72eb80b6c5?raw)