Export Models Create
Metodo HTTP: POST
Export Models Create
Saves a column selection under a name, so the same export can be repeated without picking the same columns again. Requires the export permission of the kind the model belongs to.
application/jsonRequest Body required
- name Name required
Name of the export model, shown in the picker.
- kind object
An enumeration.
- fields string[] required
Keys of the columns to save, in the order they should appear. The mandatory identifier is not stored: an export writes it whether or not the model asks for it. Read the available keys from the
fieldsendpoint of the same kind. - script Script
Post-processing script to offer with the model. It runs only when the model is used for a CSV export, and only if it is passed to the export request as
script. Null or blank for none.
200
OK
application/json403
SchemaExample (from schema)422
Schema
- id Id required
Unique identifier of the export model.
- name Name required
Name of the export model, shown in the picker.
- kind object
An enumeration.
- script Script
Post-processing script offered with the model, for CSV exports. Null when it has none.
- field_keys string[] required
Keys of the columns of the model, in the order they appear in the file. The mandatory identifier is not listed: an export writes it whether or not the model asks for it.
fields object[] required
Columns of the model, with their human-readable name.
- Array [
- key Key required
Identifier of the column, as written in the file header.
- label Label required
Human-readable name of the column. Falls back to the key when the column no longer exists.
- ]
How many columns the model selects.
create_date date-time requiredWhen the export model was created.
update_date date-time requiredWhen the export model was last modified.
{
"id": 0,
"name": "string",
"kind": "SUPPORTERS",
"script": "string",
"field_keys": [
"string"
],
"fields": [
{
"key": "string",
"label": "string"
}
],
"fields_count": 0,
"create_date": "2026-11-19T14:04:06.715Z",
"update_date": "2026-11-19T14:04:06.715Z"
}Forbidden
application/jsonSchemaExample (from schema)Schema
- detail Detail required
Why the request was refused.
{
"detail": "string"
}Unprocessable Entity
application/jsonSchemaExample (from schema)Schema
detail object[] required
The validation errors that prevented the request, the same the GraphQL
userErrorscarry.- Array [
- code Code required
Kind of error:
BAD_INPUT,NOT_FOUND,NOT_UNIQUEorPROTECTED. - field Field
Input field the error is about. Null when it is about the request.
- message Message
Human-readable explanation, in the language of the caller.
- ]
{
"detail": [
{
"code": "string",
"field": "string",
"message": "string"
}
]
}Loading...Fonte: https://dev.riseact.org/docs/rest-references/riseact-app-exports-rest-api-export-models-create. Copia automatica da dev.riseact.org: non modificare qui, le modifiche vanno fatte sulla documentazione Docusaurus.