Skip to content
DocktDocktDOCKT

Preview effective assessment policy

POST
/v1/assessment-policy/revisions/{assessmentPolicyRevisionId}/preview
curl --request POST \
  --url https://api.dockt.com/v1/assessment-policy/revisions/apol_example/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'x-dockt-expected-workspace: wsp_example'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
assessmentPolicyRevisionId
required

Unique identifier for one immutable Assessment Policy revision.

string

Header Parameters

Section titled “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.

Responses

Section titled “Responses”

200

Section titled “200”

Envelope for a single resource response.

Media typeapplication/json

Envelope for a single resource response.

object
object
required
string
Allowed values: single
data
required
object
object
required
string
Allowed values: assessment_policy_validation
revision_id
required

Unique identifier for one immutable Assessment Policy revision.

string
valid
required
boolean
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
issues
required
Array<object>
object
path
required
string
code
required
string
>= 1 characters
message
required
string
>= 1 characters
effective_rule_count
required
integer
applied_adjustment_count
required
integer
effective_rules
required
Array<object>
object
ref
required
object
source
required
string
Allowed values: compliance_package job_profile workspace
source_id
required
string
>= 1 characters
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
provenance
required
object
source
required
string
Allowed values: compliance_package job_profile workspace
source_id
required
string
>= 1 characters
source_revision
required
Any of:
string
baseline_rule_hash
required
string
>= 1 characters
effective_rule_hash
required
string
>= 1 characters
applied_adjustments
required
Array<object>
object
target
required
object
source
required
string
Allowed values: compliance_package job_profile workspace
source_id
required
string
>= 1 characters
rule_code
required
string
>= 1 characters
operation
required
string
Allowed values: change_enforcement require_also accept_also apply_only_when apply_also_when set_qualification_comparison_policy
direction
required
string
Allowed values: strengthened weakened waived
reason
required
Any of:
string
original_rule_hash
required
string
>= 1 characters
effective_rule_hash
required
string
>= 1 characters
Example
{
  "object": "single",
  "data": {
    "object": "assessment_policy_validation",
    "revision_id": "apol_example",
    "effective_rules": [
      {
        "ref": {
          "source": "compliance_package"
        },
        "applies_when": {
          "kind": "always"
        },
        "expectation": {
          "kind": "fact_comparison",
          "operator": "equals"
        },
        "enforcement": "required",
        "provenance": {
          "source": "compliance_package"
        }
      }
    ],
    "applied_adjustments": [
      {
        "target": {
          "source": "compliance_package"
        },
        "operation": "change_enforcement",
        "direction": "strengthened"
      }
    ]
  }
}

400

Section titled “400”

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

Media typeapplication/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:

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

Section titled “401”

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

Media typeapplication/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:

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

Section titled “403”

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

Media typeapplication/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:

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

Section titled “404”

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

Media typeapplication/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:

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

Section titled “409”

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

Media typeapplication/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:

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

Section titled “422”

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

Media typeapplication/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:

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

Section titled “429”

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

Media typeapplication/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:

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

Section titled “500”

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

Media typeapplication/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:

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

Section titled “503”

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

Media typeapplication/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:

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