Forms

Archive one of the organization's own forms

POST
/organizations/{organizationId}/forms/{templateId}/archive

Soft delete: open assessments keep their pinned questions, and a patch of status back to draft unarchives it

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Path Parameters

organizationId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
templateId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/forms/497f6eca-6276-4993-bfeb-53cbbbba6f08/archive" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "name": "string",  "slug": "string",  "description": "string",  "kind": "policy",  "jurisdictions": [    "string"  ],  "satisfiesObligations": [    "string"  ],  "version": 0,  "revision": 0,  "status": "active",  "iconUrl": "string",  "config": {    "type": "string",    "items": [      {        "id": "string",        "type": "text",        "label": "string",        "title": "string",        "description": "string",        "placeholder": "string",        "options": [          {            "value": "string",            "label": "string",            "disabled": true          }        ],        "defaultValue": "string",        "validationRules": {          "type": "string",          "required": true,          "min": -9007199254740991,          "max": -9007199254740991,          "pattern": "string"        },        "componentId": "string",        "entityKind": "control",        "checkedChildren": "string",        "uncheckedChildren": "string",        "sectionId": "string",        "visibleIf": {          "type": "field-equals",          "field": "string",          "value": "string"        },        "prefillFrom": "string",        "correctAnswers": [          "string"        ],        "order": -9007199254740991,        "children": {          "condition": "string",          "items": [            {              "id": "string",              "type": "text",              "label": "string",              "title": "string",              "description": "string",              "placeholder": "string",              "options": [                {                  "value": "string",                  "label": "string",                  "disabled": true                }              ],              "defaultValue": "string",              "validationRules": {                "type": "string",                "required": true,                "min": -9007199254740991,                "max": -9007199254740991,                "pattern": "string"              },              "componentId": "string",              "entityKind": "control",              "checkedChildren": "string",              "uncheckedChildren": "string",              "sectionId": "string",              "visibleIf": {                "type": "field-equals",                "field": "string",                "value": "string"              },              "prefillFrom": "string",              "correctAnswers": [                "string"              ],              "order": -9007199254740991            }          ]        }      }    ],    "sections": [      {        "id": "string",        "title": "string",        "description": "string",        "order": -9007199254740991,        "visibleIf": {          "type": "field-equals",          "field": "string",          "value": "string"        }      }    ],    "customValidation": {      "property1": null,      "property2": null    },    "outputTemplate": [      {        "property1": null,        "property2": null      }    ],    "lookups": {      "property1": {        "property1": "string",        "property2": "string"      },      "property2": {        "property1": "string",        "property2": "string"      }    },    "defaults": {      "property1": null,      "property2": null    },    "recommendedControlKeys": [      "string"    ],    "frameworkScope": [      "string"    ],    "riskRules": [      {        "id": "string",        "title": "string",        "when": {          "type": "field-equals",          "field": "string",          "value": "string"        },        "description": "string",        "likelihood": 1,        "severity": 1,        "recommendation": "string"      }    ],    "quiz": {      "items": [        {          "id": "string",          "type": "text",          "label": "string",          "title": "string",          "description": "string",          "placeholder": "string",          "options": [            {              "value": "string",              "label": "string",              "disabled": true            }          ],          "defaultValue": "string",          "validationRules": {            "type": "string",            "required": true,            "min": -9007199254740991,            "max": -9007199254740991,            "pattern": "string"          },          "componentId": "string",          "entityKind": "control",          "checkedChildren": "string",          "uncheckedChildren": "string",          "sectionId": "string",          "visibleIf": {            "type": "field-equals",            "field": "string",            "value": "string"          },          "prefillFrom": "string",          "correctAnswers": [            "string"          ],          "order": -9007199254740991,          "children": {            "condition": "string",            "items": [              {                "id": "string",                "type": "text",                "label": "string",                "title": "string",                "description": "string",                "placeholder": "string",                "options": [                  {                    "value": "string",                    "label": "string",                    "disabled": true                  }                ],                "defaultValue": "string",                "validationRules": {                  "type": "string",                  "required": true,                  "min": -9007199254740991,                  "max": -9007199254740991,                  "pattern": "string"                },                "componentId": "string",                "entityKind": "control",                "checkedChildren": "string",                "uncheckedChildren": "string",                "sectionId": "string",                "visibleIf": {                  "type": "field-equals",                  "field": "string",                  "value": "string"                },                "prefillFrom": "string",                "correctAnswers": [                  "string"                ],                "order": -9007199254740991              }            ]          }        }      ],      "passPercent": 1    }  },  "publishedConfig": {    "type": "string",    "items": [      {        "id": "string",        "type": "text",        "label": "string",        "title": "string",        "description": "string",        "placeholder": "string",        "options": [          {            "value": "string",            "label": "string",            "disabled": true          }        ],        "defaultValue": "string",        "validationRules": {          "type": "string",          "required": true,          "min": -9007199254740991,          "max": -9007199254740991,          "pattern": "string"        },        "componentId": "string",        "entityKind": "control",        "checkedChildren": "string",        "uncheckedChildren": "string",        "sectionId": "string",        "visibleIf": {          "type": "field-equals",          "field": "string",          "value": "string"        },        "prefillFrom": "string",        "correctAnswers": [          "string"        ],        "order": -9007199254740991,        "children": {          "condition": "string",          "items": [            {              "id": "string",              "type": "text",              "label": "string",              "title": "string",              "description": "string",              "placeholder": "string",              "options": [                {                  "value": "string",                  "label": "string",                  "disabled": true                }              ],              "defaultValue": "string",              "validationRules": {                "type": "string",                "required": true,                "min": -9007199254740991,                "max": -9007199254740991,                "pattern": "string"              },              "componentId": "string",              "entityKind": "control",              "checkedChildren": "string",              "uncheckedChildren": "string",              "sectionId": "string",              "visibleIf": {                "type": "field-equals",                "field": "string",                "value": "string"              },              "prefillFrom": "string",              "correctAnswers": [                "string"              ],              "order": -9007199254740991            }          ]        }      }    ],    "sections": [      {        "id": "string",        "title": "string",        "description": "string",        "order": -9007199254740991,        "visibleIf": {          "type": "field-equals",          "field": "string",          "value": "string"        }      }    ],    "customValidation": {      "property1": null,      "property2": null    },    "outputTemplate": [      {        "property1": null,        "property2": null      }    ],    "lookups": {      "property1": {        "property1": "string",        "property2": "string"      },      "property2": {        "property1": "string",        "property2": "string"      }    },    "defaults": {      "property1": null,      "property2": null    },    "recommendedControlKeys": [      "string"    ],    "frameworkScope": [      "string"    ],    "riskRules": [      {        "id": "string",        "title": "string",        "when": {          "type": "field-equals",          "field": "string",          "value": "string"        },        "description": "string",        "likelihood": 1,        "severity": 1,        "recommendation": "string"      }    ],    "quiz": {      "items": [        {          "id": "string",          "type": "text",          "label": "string",          "title": "string",          "description": "string",          "placeholder": "string",          "options": [            {              "value": "string",              "label": "string",              "disabled": true            }          ],          "defaultValue": "string",          "validationRules": {            "type": "string",            "required": true,            "min": -9007199254740991,            "max": -9007199254740991,            "pattern": "string"          },          "componentId": "string",          "entityKind": "control",          "checkedChildren": "string",          "uncheckedChildren": "string",          "sectionId": "string",          "visibleIf": {            "type": "field-equals",            "field": "string",            "value": "string"          },          "prefillFrom": "string",          "correctAnswers": [            "string"          ],          "order": -9007199254740991,          "children": {            "condition": "string",            "items": [              {                "id": "string",                "type": "text",                "label": "string",                "title": "string",                "description": "string",                "placeholder": "string",                "options": [                  {                    "value": "string",                    "label": "string",                    "disabled": true                  }                ],                "defaultValue": "string",                "validationRules": {                  "type": "string",                  "required": true,                  "min": -9007199254740991,                  "max": -9007199254740991,                  "pattern": "string"                },                "componentId": "string",                "entityKind": "control",                "checkedChildren": "string",                "uncheckedChildren": "string",                "sectionId": "string",                "visibleIf": {                  "type": "field-equals",                  "field": "string",                  "value": "string"                },                "prefillFrom": "string",                "correctAnswers": [                  "string"                ],                "order": -9007199254740991              }            ]          }        }      ],      "passPercent": 1    }  },  "dateCreated": null,  "dateUpdated": null,  "organizationId": "string",  "formTemplateId": "string",  "formTemplateVersion": 0,  "latestTemplateVersion": 0,  "updateAvailable": true}