Export walk/form template(s) as ZIP

POST /walk-creator/v1/templates/export

Operation id: exportWalkTemplateModel

Description

Exports one or more templates to a ZIP package on the server upload directory.

Mirrors legacy POST /service/api/v2/model/exportModel and delegates to the same ImportExportService.exportAllModel implementation.

Authentication: X-reflexis-csrf-token-X required. Domain context is resolved from the session — do not send domain_id / auth_token as form fields.

model_id may be a single id or a comma-separated list.

Tags: WalkCreatorTemplateImportExport

Security

  • ApiKeyHeader (apiKey)
    • APIGEE API key header validated by VerifyAPIKey policy.
  • AuthTokenHeader (apiKey)
    • Session authentication token validated server-side against the user session store. Required on every request. Absence returns HTTP 400; invalid/expired token returns HTTP 401.

Responses

200 — Success returns status: OK and export file metadata under template_export.

Application-level failures may also return HTTP 200 with status: ER.

Content type: application/json

400 — Invalid or missing required request parameter.

Content type: application/json

401 — Missing or invalid X-reflexis-csrf-token-X session token.

Content type: application/json

500 — Unexpected server-side error.

Content type: application/json

Request body

Required: Yes

application/x-www-form-urlencoded

Schema

PropertyTypeRequiredDescription
model_idstringYesTemplate model id, or comma-separated list of model ids.
model_typestringNoModel type code (e.g. W for walk, F for form).
category_idstringNoOptional category filter for the export.
{
  "type": "object",
  "required": [
    "model_id"
  ],
  "properties": {
    "model_id": {
      "type": "string",
      "description": "Template model id, or comma-separated list of model ids.",
      "example": "FORM_123,FORM_456"
    },
    "model_type": {
      "type": "string",
      "description": "Model type code (e.g. `W` for walk, `F` for form).",
      "example": "W"
    },
    "category_id": {
      "type": "string",
      "description": "Optional category filter for the export."
    }
  }
}

Response models

200 — Success returns status: OK and export file metadata under template_export.

Application-level failures may also return HTTP 200 with status: ER.

Content type: application/json

Schema

{
  "oneOf": [
    {
      "type": "object",
      "required": [
        "status",
        "template_export"
      ],
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "OK"
          ]
        },
        "template_export": {
          "type": "object",
          "description": "Export result from `ImportExportService.exportAllModel`.\nKeys are snake_cased in the next-gen envelope (`file_path`, `file_list`).\n",
          "required": [
            "file_path",
            "file_list"
          ],
          "properties": {
            "file_path": {
              "type": "string",
              "description": "Directory containing the export ZIP before client download."
            },
            "file_list": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "path",
                  "name"
                ]
              }
            }
          }
        }
      }
    },
    {
      "type": "object",
      "description": "Error envelope shape depends on how the error is produced:\n\n- **HTTP 200** — business or validation failure after the request is accepted:\n  `{ \"status\": \"ER\", \"error\": \"<string or JSON>\" }` (no `errorCode`).\n- **HTTP 4xx/5xx** — structured API error:\n  `{ \"status\": \"ER\", \"errorCode\": \"<code>\", \"response\": \"<localized message>\" }`.\n",
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "ER"
          ]
        },
        "errorCode": {
          "type": "string",
          "description": "Structured error code for HTTP 4xx/5xx responses."
        },
        "response": {
          "type": "string",
          "description": "Human-readable message when `errorCode` is present (HTTP 4xx/5xx responses)."
        },
        "error": {
          "description": "Payload for HTTP 200 error bodies (string, array, or object).",
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "array",
              "items": {}
            },
            {
              "type": "object"
            }
          ]
        }
      }
    }
  ]
}

400 — Invalid or missing required request parameter.

Content type: application/json

Schema

Error envelope shape depends on how the error is produced:

  • HTTP 200 — business or validation failure after the request is accepted: { "status": "ER", "error": "<string or JSON>" } (no errorCode).
  • HTTP 4xx/5xx — structured API error: { "status": "ER", "errorCode": "<code>", "response": "<localized message>" }.
PropertyTypeRequiredDescription
statusstringNo
errorCodestringNoStructured error code for HTTP 4xx/5xx responses.
responsestringNoHuman-readable message when errorCode is present (HTTP 4xx/5xx responses).
erroroneOfNoPayload for HTTP 200 error bodies (string, array, or object).
{
  "type": "object",
  "description": "Error envelope shape depends on how the error is produced:\n\n- **HTTP 200** — business or validation failure after the request is accepted:\n  `{ \"status\": \"ER\", \"error\": \"<string or JSON>\" }` (no `errorCode`).\n- **HTTP 4xx/5xx** — structured API error:\n  `{ \"status\": \"ER\", \"errorCode\": \"<code>\", \"response\": \"<localized message>\" }`.\n",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Structured error code for HTTP 4xx/5xx responses."
    },
    "response": {
      "type": "string",
      "description": "Human-readable message when `errorCode` is present (HTTP 4xx/5xx responses)."
    },
    "error": {
      "description": "Payload for HTTP 200 error bodies (string, array, or object).",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {}
        },
        {
          "type": "object"
        }
      ]
    }
  }
}

Example:

{
  "status": "ER",
  "errorCode": "E110",
  "response": "model_id is mandatory"
}

401 — Missing or invalid X-reflexis-csrf-token-X session token.

Content type: application/json

Schema

Error envelope shape depends on how the error is produced:

  • HTTP 200 — business or validation failure after the request is accepted: { "status": "ER", "error": "<string or JSON>" } (no errorCode).
  • HTTP 4xx/5xx — structured API error: { "status": "ER", "errorCode": "<code>", "response": "<localized message>" }.
PropertyTypeRequiredDescription
statusstringNo
errorCodestringNoStructured error code for HTTP 4xx/5xx responses.
responsestringNoHuman-readable message when errorCode is present (HTTP 4xx/5xx responses).
erroroneOfNoPayload for HTTP 200 error bodies (string, array, or object).
{
  "type": "object",
  "description": "Error envelope shape depends on how the error is produced:\n\n- **HTTP 200** — business or validation failure after the request is accepted:\n  `{ \"status\": \"ER\", \"error\": \"<string or JSON>\" }` (no `errorCode`).\n- **HTTP 4xx/5xx** — structured API error:\n  `{ \"status\": \"ER\", \"errorCode\": \"<code>\", \"response\": \"<localized message>\" }`.\n",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Structured error code for HTTP 4xx/5xx responses."
    },
    "response": {
      "type": "string",
      "description": "Human-readable message when `errorCode` is present (HTTP 4xx/5xx responses)."
    },
    "error": {
      "description": "Payload for HTTP 200 error bodies (string, array, or object).",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {}
        },
        {
          "type": "object"
        }
      ]
    }
  }
}

500 — Unexpected server-side error.

Content type: application/json

Schema

Error envelope shape depends on how the error is produced:

  • HTTP 200 — business or validation failure after the request is accepted: { "status": "ER", "error": "<string or JSON>" } (no errorCode).
  • HTTP 4xx/5xx — structured API error: { "status": "ER", "errorCode": "<code>", "response": "<localized message>" }.
PropertyTypeRequiredDescription
statusstringNo
errorCodestringNoStructured error code for HTTP 4xx/5xx responses.
responsestringNoHuman-readable message when errorCode is present (HTTP 4xx/5xx responses).
erroroneOfNoPayload for HTTP 200 error bodies (string, array, or object).
{
  "type": "object",
  "description": "Error envelope shape depends on how the error is produced:\n\n- **HTTP 200** — business or validation failure after the request is accepted:\n  `{ \"status\": \"ER\", \"error\": \"<string or JSON>\" }` (no `errorCode`).\n- **HTTP 4xx/5xx** — structured API error:\n  `{ \"status\": \"ER\", \"errorCode\": \"<code>\", \"response\": \"<localized message>\" }`.\n",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Structured error code for HTTP 4xx/5xx responses."
    },
    "response": {
      "type": "string",
      "description": "Human-readable message when `errorCode` is present (HTTP 4xx/5xx responses)."
    },
    "error": {
      "description": "Payload for HTTP 200 error bodies (string, array, or object).",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {}
        },
        {
          "type": "object"
        }
      ]
    }
  }
}

Example:

{
  "status": "ER",
  "errorCode": "E500",
  "response": "Unexpected server error."
}