Apply guided assessment policy authoring command

POST

/v1/assessment-policy/revisions/{assessmentPolicyRevisionId}/commands

const url = 'https://api.dockt.com/v1/assessment-policy/revisions/apol_example/commands';
const options = {
  method: 'POST',
  headers: {
    'x-dockt-expected-workspace': 'wsp_example',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"expected_lock_version":1,"command":{"kind":"upsert_workspace_rule","rule_code":"example","label":"example","applies_when":{"kind":"always"},"expectation":{"kind":"fact_comparison","fact":"example","operator":"equals","value":"example"},"enforcement":"required"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.dockt.com/v1/assessment-policy/revisions/apol_example/commands \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-dockt-expected-workspace: wsp_example' \
  --data '{ "expected_lock_version": 1, "command": { "kind": "upsert_workspace_rule", "rule_code": "example", "label": "example", "applies_when": { "kind": "always" }, "expectation": { "kind": "fact_comparison", "fact": "example", "operator": "equals", "value": "example" }, "enforcement": "required" } }'

Authorizations

bearerAuth
sessionCookie

Parameters

Path Parameters

assessmentPolicyRevisionId

required

Unique identifier for one immutable Assessment Policy revision.

string

Header Parameters

x-dockt-expected-user

Rejects the request with 401 unless the browser session belongs to this auth_user_id. This assertion does not grant authority.

string

>= 1 characters

x-dockt-expected-workspace

Unique Dockt workspace identifier.

Request Body^required

application/json

object

expected_lock_version

required

integer

>= 1

command

required

Any of:

object

kind

required

string

Allowed values: upsert_workspace_rule

rule_code

required

string

>= 1 characters

label

required

Human-readable name shown in Dockt and customer systems.

string

>= 1 characters <= 120 characters

applies_when

required

Any of:

object

kind

required

string

Allowed values: always

expectation

required

Any of:

object

kind

required

string

Allowed values: fact_comparison

fact

required

string

>= 1 characters

operator

required

string

Allowed values: equals not_equals greater_than greater_than_or_equal less_than less_than_or_equal

value

required

Any of:

string

enforcement

required

string

Allowed values: required advisory waived

Responses

200

Envelope for a single resource response.

application/json

Envelope for a single resource response.

object

object

required

string

Allowed values: single

data

required

Editable draft or immutable published Assessment Policy revision.

object

object

required

string

Allowed values: assessment_policy_revision

required

Unique identifier for one immutable Assessment Policy revision.

string

workspace_id

required

Unique Dockt workspace identifier.

string

revision

required

integer

>= 1

status

required

string

Allowed values: draft active superseded

policy_language_version

required

string

>= 1 characters

catalog_version

required

string

>= 1 characters

lock_version

required

integer

>= 1

require_job_profile_qualification_uploads

required

Require uploaded proof substantiating each accepted Job Profile qualification. Registry discovery alone is insufficient. Defaults to false for new policies.

boolean

compliance_packages

required

Array<object>

object

code

required

string

>= 1 characters

version

required

string

>= 1 characters

qualification_definition_revision_ids

required

Array<string>

workspace_rules

required

Array<object>

object

rule_code

required

string

>= 1 characters

label

required

Human-readable name shown in Dockt and customer systems.

string

>= 1 characters <= 120 characters

applies_when

required

Any of:

object

kind

required

string

Allowed values: always

expectation

required

Any of:

object

kind

required

string

Allowed values: fact_comparison

fact

required

string

>= 1 characters

operator

required

string

Allowed values: equals not_equals greater_than greater_than_or_equal less_than less_than_or_equal

value

required

Any of:

string

enforcement

required

string

Allowed values: required advisory waived

rule_overrides

required

Array<object>

object

target

required

object

source

required

string

Allowed values: compliance_package

source_id

required

string

>= 1 characters

rule_code

required

string

>= 1 characters

enforcement

string

Allowed values: required advisory waived

qualification_comparison_policy

Any of:

object
object

object

mode

required

string

Allowed values: accepted_only

require_also

Array

>= 1 items

Any of:

object

kind

required

string

Allowed values: fact_comparison

fact

required

string

>= 1 characters

operator

required

string

Allowed values: equals not_equals greater_than greater_than_or_equal less_than less_than_or_equal

value

required

Any of:

string

accept_also

Array

>= 1 items

Any of:

object

kind

required

string

Allowed values: fact_comparison

fact

required

string

>= 1 characters

operator

required

string

Allowed values: equals not_equals greater_than greater_than_or_equal less_than less_than_or_equal

value

required

Any of:

string

apply_only_when

Array

>= 1 items

Any of:

object

kind

required

string

Allowed values: always

apply_also_when

Array

>= 1 items

Any of:

object

kind

required

string

Allowed values: always

reason

string

>= 1 characters

activated_at

required

Any of:

string
null

ISO 8601 date-time string.

string format: date-time

created_at

required

ISO 8601 date-time string.

string format: date-time

updated_at

required

ISO 8601 date-time string.

string format: date-time

Example

{
  "object": "single",
  "data": {
    "object": "assessment_policy_revision",
    "id": "apol_example",
    "workspace_id": "wsp_example",
    "status": "draft",
    "workspace_rules": [
      {
        "applies_when": {
          "kind": "always"
        },
        "expectation": {
          "kind": "fact_comparison",
          "operator": "equals"
        },
        "enforcement": "required"
      }
    ],
    "rule_overrides": [
      {
        "target": {
          "source": "compliance_package"
        },
        "enforcement": "required",
        "qualification_comparison_policy": {
          "mode": "accepted_only"
        },
        "require_also": [
          {
            "kind": "fact_comparison",
            "operator": "equals"
          }
        ],
        "accept_also": [
          {
            "kind": "fact_comparison",
            "operator": "equals"
          }
        ],
        "apply_only_when": [
          {
            "kind": "always"
          }
        ],
        "apply_also_when": [
          {
            "kind": "always"
          }
        ]
      }
    ],
    "activated_at": "2026-08-06T09:30:00Z",
    "created_at": "2026-08-06T09:30:00Z",
    "updated_at": "2026-08-06T09:30:00Z"
  }
}

400

Problem Details response for HTTP 400. The type URI is the stable machine-readable error code.

application/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object

type

required

string

title

required

string

status

required

number

detail

required

string

instance

required

Any of:

string
null

Request identifier that Dockt support can use to trace an API call.

string

errors

Structured request validation issues.

object

issues

required

Array<object>

One request validation issue with a stable field path and human-readable message.

object

path

required

Array

message

required

string

Example

{
  "type": "https://docs.dockt.com/errors/invalid-request",
  "title": "Bad request",
  "status": 400,
  "detail": "The request did not match the expected schema.",
  "instance": "req_example1042"
}

401

Problem Details response for HTTP 401. The type URI is the stable machine-readable error code.

application/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object

type

required

string

title

required

string

status

required

number

detail

required

string

instance

required

Any of:

string
null

Request identifier that Dockt support can use to trace an API call.

string

errors

Structured request validation issues.

object

issues

required

Array<object>

One request validation issue with a stable field path and human-readable message.

object

path

required

Array

message

required

string

Example

{
  "type": "https://docs.dockt.com/errors/missing-auth",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Send a valid bearer token or browser session.",
  "instance": "req_example1042"
}

403

Problem Details response for HTTP 403. The type URI is the stable machine-readable error code.

application/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object

type

required

string

title

required

string

status

required

number

detail

required

string

instance

required

Any of:

string
null

Request identifier that Dockt support can use to trace an API call.

string

errors

Structured request validation issues.

object

issues

required

Array<object>

One request validation issue with a stable field path and human-readable message.

object

path

required

Array

message

required

string

Example

{
  "type": "https://docs.dockt.com/errors/forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The authenticated principal does not have the required permission.",
  "instance": "req_example1042"
}

404

Problem Details response for HTTP 404. The type URI is the stable machine-readable error code.

application/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object

type

required

string

title

required

string

status

required

number

detail

required

string

instance

required

Any of:

string
null

Request identifier that Dockt support can use to trace an API call.

string

errors

Structured request validation issues.

object

issues

required

Array<object>

One request validation issue with a stable field path and human-readable message.

object

path

required

Array

message

required

string

Example

{
  "type": "https://docs.dockt.com/errors/not-found",
  "title": "Not found",
  "status": 404,
  "detail": "The requested resource was not found in the authenticated scope.",
  "instance": "req_example1042"
}

409

Problem Details response for HTTP 409. The type URI is the stable machine-readable error code.

application/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object

type

required

string

title

required

string

status

required

number

detail

required

string

instance

required

Any of:

string
null

Request identifier that Dockt support can use to trace an API call.

string

errors

Structured request validation issues.

object

issues

required

Array<object>

One request validation issue with a stable field path and human-readable message.

object

path

required

Array

message

required

string

Example

{
  "type": "https://docs.dockt.com/errors/conflict",
  "title": "Conflict",
  "status": 409,
  "detail": "The request conflicts with the current resource state.",
  "instance": "req_example1042"
}

422

Problem Details response for HTTP 422. The type URI is the stable machine-readable error code.

application/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object

type

required

string

title

required

string

status

required

number

detail

required

string

instance

required

Any of:

string
null

Request identifier that Dockt support can use to trace an API call.

string

errors

Structured request validation issues.

object

issues

required

Array<object>

One request validation issue with a stable field path and human-readable message.

object

path

required

Array

message

required

string

Example

{
  "type": "https://docs.dockt.com/errors/validation",
  "title": "Validation failed",
  "status": 422,
  "detail": "Correct the invalid fields and send the request again.",
  "instance": "req_example1042",
  "errors": {
    "issues": [
      {
        "path": [
          "body",
          "inputs",
          "3",
          "value"
        ],
        "message": "Expected a two-letter country code."
      }
    ]
  }
}

429

Problem Details response for HTTP 429. The type URI is the stable machine-readable error code.

application/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object

type

required

string

title

required

string

status

required

number

detail

required

string

instance

required

Any of:

string
null

Request identifier that Dockt support can use to trace an API call.

string

errors

Structured request validation issues.

object

issues

required

Array<object>

One request validation issue with a stable field path and human-readable message.

object

path

required

Array

message

required

string

Example

{
  "type": "https://docs.dockt.com/errors/rate-limit",
  "title": "Too many requests",
  "status": 429,
  "detail": "Wait for the Retry-After interval before retrying.",
  "instance": "req_example1042"
}

500

Problem Details response for HTTP 500. The type URI is the stable machine-readable error code.

application/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object

type

required

string

title

required

string

status

required

number

detail

required

string

instance

required

Any of:

string
null

Request identifier that Dockt support can use to trace an API call.

string

errors

Structured request validation issues.

object

issues

required

Array<object>

One request validation issue with a stable field path and human-readable message.

object

path

required

Array

message

required

string

Example

{
  "type": "https://docs.dockt.com/errors/internal",
  "title": "Internal server error",
  "status": 500,
  "detail": "Retry the request safely or contact Dockt support with the request ID.",
  "instance": "req_example1042"
}

503

Problem Details response for HTTP 503. The type URI is the stable machine-readable error code.

application/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object

type

required

string

title

required

string

status

required

number

detail

required

string

instance

required

Any of:

string
null

Request identifier that Dockt support can use to trace an API call.

string

errors

Structured request validation issues.

object

issues

required

Array<object>

One request validation issue with a stable field path and human-readable message.

object

path

required

Array

message

required

string

Example

{
  "instance": "req_example1042"
}

Apply guided assessment policy authoring command

Authorizations

Parameters

Path Parameters

Header Parameters

Request Bodyrequired

Responses

200

Example

400

Example

401

Example

403

Example

404

Example

409

Example

422

Example

429

Example

500

Example

503

Example

Analytics cookies

Request Body^required