---
title: "Assess commitment quality"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sureshake.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sureshake API › execution

`POST /v2/execution/cycles/{cycleId}/commitment-quality-assessment`

## Path parameters

- `cycleId` (`execution-assess-commitment-quality.path.cycleId`; string, required)
  - format `uuid`

## Request body

_Required._

- `outcome` (`execution-assess-commitment-quality.outcome`; string, required)
  - minLength 1; maxLength 500
- `completionDefinition` (`execution-assess-commitment-quality.completionDefinition`; string, required)
  - minLength 1; maxLength 2000
- `proofStandard` (`execution-assess-commitment-quality.proofStandard`; string, required)
  - minLength 1; maxLength 2000
- `targetValue` (`execution-assess-commitment-quality.targetValue`; number, optional)
  - min -1000000000000000; max 1000000000000000

## Example request

```json
{
  "outcome": "string",
  "completionDefinition": "string",
  "proofStandard": "string",
  "targetValue": -1000000000000000
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url 'https://api.sureshake.com/v2/execution/cycles/<cycleId>/commitment-quality-assessment' \
  --header 'Content-Type: application/json' \
  --data '
{
  "outcome": "string",
  "completionDefinition": "string",
  "proofStandard": "string",
  "targetValue": -1000000000000000
}
'
```

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/execution/cycles/<cycleId>/commitment-quality-assessment';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    outcome: 'string',
    completionDefinition: 'string',
    proofStandard: 'string',
    targetValue: -1000000000000000
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sureshake.com/v2/execution/cycles/<cycleId>/commitment-quality-assessment"

payload = {
    "outcome": "string",
    "completionDefinition": "string",
    "proofStandard": "string",
    "targetValue": -1000000000000000
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": {
    "objectivelyCloseable": true,
    "warnings": [
      {
        "code": "activity_based",
        "message": "string",
        "fields": [
          "outcome"
        ]
      }
    ]
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`execution-assess-commitment-quality.response.200.data`; object, required)
  - `objectivelyCloseable` (`execution-assess-commitment-quality.response.200.data.objectivelyCloseable`; boolean, required)
  - `warnings` (`execution-assess-commitment-quality.response.200.data.warnings`; array<object>, required)
    - `code` (`execution-assess-commitment-quality.response.200.data.warnings.code`; string, required)
      - one of `"activity_based"`, `"not_objectively_closeable"`
    - `message` (`execution-assess-commitment-quality.response.200.data.warnings.message`; string, required)
      - minLength 1; maxLength 500
    - `fields` (`execution-assess-commitment-quality.response.200.data.warnings.fields`; array<string>, required)
      - one of `"outcome"`, `"completionDefinition"`, `"proofStandard"`
- `meta` (`execution-assess-commitment-quality.response.200.meta`; object, optional)
  - `timestamp` (`execution-assess-commitment-quality.response.200.meta.timestamp`; string, required)
    - format `date-time`

### 400

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`execution-assess-commitment-quality.response.400.error`; object, required)
  - `code` (`execution-assess-commitment-quality.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-assess-commitment-quality.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`execution-assess-commitment-quality.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-assess-commitment-quality.response.400.error.traceId`; string, optional) — Unique ID for log correlation

### 401

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`execution-assess-commitment-quality.response.401.error`; object, required)
  - `code` (`execution-assess-commitment-quality.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-assess-commitment-quality.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`execution-assess-commitment-quality.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-assess-commitment-quality.response.401.error.traceId`; string, optional) — Unique ID for log correlation

### 403

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`execution-assess-commitment-quality.response.403.error`; object, required)
  - `code` (`execution-assess-commitment-quality.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-assess-commitment-quality.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`execution-assess-commitment-quality.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-assess-commitment-quality.response.403.error.traceId`; string, optional) — Unique ID for log correlation

### 404

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`execution-assess-commitment-quality.response.404.error`; object, required)
  - `code` (`execution-assess-commitment-quality.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-assess-commitment-quality.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`execution-assess-commitment-quality.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-assess-commitment-quality.response.404.error.traceId`; string, optional) — Unique ID for log correlation

### 409

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`execution-assess-commitment-quality.response.409.error`; object, required)
  - `code` (`execution-assess-commitment-quality.response.409.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-assess-commitment-quality.response.409.error.message`; string, required) — Human-readable error message
  - `details` (`execution-assess-commitment-quality.response.409.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-assess-commitment-quality.response.409.error.traceId`; string, optional) — Unique ID for log correlation

### 422

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`execution-assess-commitment-quality.response.422.error`; object, required)
  - `code` (`execution-assess-commitment-quality.response.422.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-assess-commitment-quality.response.422.error.message`; string, required) — Human-readable error message
  - `details` (`execution-assess-commitment-quality.response.422.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-assess-commitment-quality.response.422.error.traceId`; string, optional) — Unique ID for log correlation

### 429

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`execution-assess-commitment-quality.response.429.error`; object, required)
  - `code` (`execution-assess-commitment-quality.response.429.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-assess-commitment-quality.response.429.error.message`; string, required) — Human-readable error message
  - `details` (`execution-assess-commitment-quality.response.429.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-assess-commitment-quality.response.429.error.traceId`; string, optional) — Unique ID for log correlation

### 500

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`execution-assess-commitment-quality.response.500.error`; object, required)
  - `code` (`execution-assess-commitment-quality.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-assess-commitment-quality.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`execution-assess-commitment-quality.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-assess-commitment-quality.response.500.error.traceId`; string, optional) — Unique ID for log correlation

### 502

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`execution-assess-commitment-quality.response.502.error`; object, required)
  - `code` (`execution-assess-commitment-quality.response.502.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-assess-commitment-quality.response.502.error.message`; string, required) — Human-readable error message
  - `details` (`execution-assess-commitment-quality.response.502.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-assess-commitment-quality.response.502.error.traceId`; string, optional) — Unique ID for log correlation

### 503

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`execution-assess-commitment-quality.response.503.error`; object, required)
  - `code` (`execution-assess-commitment-quality.response.503.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-assess-commitment-quality.response.503.error.message`; string, required) — Human-readable error message
  - `details` (`execution-assess-commitment-quality.response.503.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-assess-commitment-quality.response.503.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/execution-assess-commitment-quality/index.md