Exports / Create
Initiates a new export..
Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/exports
Method: POST
Authorisation: Minimum role: ADMIN
Response object
Response status: 200 (OK)
Response type: DTO_export
Wrapper: DTO_response_wrap
Other response statuses: 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_export
Name | Type | ReadOnly | Description |
---|---|---|---|
created_by | DTO_reference_user | ReadOnly | Created by |
last_updated_by | DTO_reference_user | ReadOnly | Last updated by |
id | Int32 | ReadOnly | Leave empty on input |
created | DateTime | ReadOnly | Created |
last_updated | DateTime | ReadOnly | Last updated |
type | ENUM export_type | Type |
DTO_reference_user
Name | Type | ReadOnly | Description |
---|---|---|---|
profile_pic | String | ReadOnly | Profile pic |
String | ReadOnly | ||
id | Int32 | Id | |
label | Object | ReadOnly | Label |
ENUM export_type
Value | Name | Description |
---|---|---|
0 | UNKNOWN | UNKNOWN |
1 | EML | EML |