Get policy authoring catalog

GET

/v1/policy-authoring-catalog

const url = 'https://api.dockt.com/v1/policy-authoring-catalog';
const options = {
  method: 'GET',
  headers: {'x-dockt-expected-workspace': 'wsp_example', Authorization: 'Bearer <token>'}
};

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

curl --request GET \
  --url https://api.dockt.com/v1/policy-authoring-catalog \
  --header 'Authorization: Bearer <token>' \
  --header 'x-dockt-expected-workspace: wsp_example'

Authorizations

bearerAuth
sessionCookie

Parameters

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

200

Envelope for a single resource response.

application/json

Envelope for a single resource response.

object

object

required

string

Allowed values: single

data

required

Compiler-owned vocabulary available to guided policy authoring interfaces.

object

object

required

string

Allowed values: policy_authoring_catalog

policy_language_version

required

string

>= 1 characters

version

required

string

>= 1 characters

facts

required

Array<object>

object

code

required

string

>= 1 characters

label

required

Human-readable name shown in Dockt and customer systems.

string

>= 1 characters <= 120 characters

description

required

string

>= 1 characters

value_type

required

string

Allowed values: boolean number string enum date

allowed_operators

required

Array<string>

Allowed values: equals not_equals greater_than greater_than_or_equal less_than less_than_or_equal

options

Array<object>

object

value

required

string

label

required

Human-readable name shown in Dockt and customer systems.

string

>= 1 characters <= 120 characters

availability

required

string

Allowed values: assessment_input derived evidence_derived

usable_for

required

Array<string>

Allowed values: applicability expectation

assessment_input_fields

Array<object>

An available assessment field and the metadata needed to supply or render it. Missing cardinality means one value.

object

code

required

string

>= 1 characters

label

required

Human-readable name shown in Dockt and customer systems.

string

>= 1 characters <= 120 characters

value_type

required

Known values: string, integer, boolean, date, country_code, single_select. New values may appear; preserve unfamiliar values and use a safe fallback.

string

>= 1 characters

cardinality

Known values: one, many. New values may appear; preserve unfamiliar values and use a safe fallback.

string

>= 1 characters

max_items

integer

>= 1 <= 8

unit

string

>= 1 characters

options

required

Array<object>

object

value

required

string

>= 1 characters

label

required

Human-readable name shown in Dockt and customer systems.

string

>= 1 characters <= 120 characters

evidence_types

required

Array<object>

object

type

required

string

>= 1 characters

label

required

Human-readable name shown in Dockt and customer systems.

string

>= 1 characters <= 120 characters

source_domain

required

string

Allowed values: social technical

qualification_definitions

required

Array<object>

object

required

string

>= 1 characters

code

required

string

>= 1 characters

title

required

Human-readable name shown in Dockt and customer systems.

string

>= 1 characters <= 120 characters

scheme_code

required

string

>= 1 characters

revision_id

required

Any of:

string
null

string

>= 1 characters

recognition_configured

Any of:

boolean
null

boolean

qualification_reference_resolutions

Any of:

Array<object>
null

Array<object>

object

reference_id

required

string

reference_fingerprint

required

string

qualification_definition_id

required

Any of:

string
null

string

qualification_comparison_presets

required

Array<object>

object

code

required

string

>= 1 characters

label

required

Human-readable name shown in Dockt and customer systems.

string

>= 1 characters <= 120 characters

policy

required

Any of:

object
object

object

mode

required

string

Allowed values: accepted_only

assurance_levels

required

Array<object>

object

code

required

string

Allowed values: declared document_supported authority_verified

label

required

Human-readable name shown in Dockt and customer systems.

string

>= 1 characters <= 120 characters

rule_templates

required

Array<object>

object

code

required

string

Allowed values: technical_requirement minimum_fact required_fact required_document

label

required

Human-readable name shown in Dockt and customer systems.

string

>= 1 characters <= 120 characters

rule_override_capabilities

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

allowed_overrides

required

Array<string>

Allowed values: change_enforcement require_also accept_also apply_only_when apply_also_when set_qualification_comparison_policy

Example

{
  "object": "single",
  "data": {
    "object": "policy_authoring_catalog",
    "facts": [
      {
        "value_type": "boolean",
        "allowed_operators": [
          "equals"
        ],
        "availability": "assessment_input",
        "usable_for": [
          "applicability"
        ]
      }
    ],
    "assessment_input_fields": [
      {
        "value_type": "string",
        "cardinality": "one"
      }
    ],
    "evidence_types": [
      {
        "source_domain": "social"
      }
    ],
    "qualification_comparison_presets": [
      {
        "policy": {
          "mode": "accepted_only"
        }
      }
    ],
    "assurance_levels": [
      {
        "code": "declared"
      }
    ],
    "rule_templates": [
      {
        "code": "technical_requirement"
      }
    ],
    "rule_override_capabilities": [
      {
        "target": {
          "source": "compliance_package"
        },
        "allowed_overrides": [
          "change_enforcement"
        ]
      }
    ]
  }
}

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

Get policy authoring catalog

Authorizations

Parameters

Header Parameters

Responses

200

Example

400

Example

401

Example

403

Example

404

Example

409

Example

422

Example

429

Example

500

Example

503

Example

Analytics cookies