# Exports

{% openapi src="<https://content.gitbook.com/content/tXIYKGMTeHub5C8O9fER/blobs/TC8KXqdBoVrA1ZGmo9Kk/UshahidiV3.json>" path="/api/v3/exports/jobs" method="get" %}
[UshahidiV3.json](https://content.gitbook.com/content/tXIYKGMTeHub5C8O9fER/blobs/TC8KXqdBoVrA1ZGmo9Kk/UshahidiV3.json)
{% endopenapi %}

## add export

<mark style="color:green;">`POST`</mark> `https://ushahididocs.api.ushahidi.io/api/v3/exports/jobs`

#### Request Body

| Name                | Type    | Description                                          |
| ------------------- | ------- | ---------------------------------------------------- |
| user\_id            | String  | The user identifier                                  |
| url\_expiration     | Integer |                                                      |
| updated             | String  |                                                      |
| header\_row         | String  |                                                      |
| status              | String  |                                                      |
| filters             | String  |                                                      |
| fields              | String  |                                                      |
| entity\_type        | String  | The entity types                                     |
| hxl\_heading\_row   | String  |                                                      |
| send\_to\_hdx       | String  | Set true to send HXL and false not to send HXL       |
| send\_to\_browser   | String  |                                                      |
| include\_hxl        | Boolean | Set true to include HXL and false not to include HXL |
| total\_rows         | String  |                                                      |
| total\_batches      | String  |                                                      |
| hxl\_meta\_data\_id | String  |                                                      |

{% tabs %}
{% tab title="200: OK " %}

```javascript
{
    "id": 9,
    "url": null,
    "user": {
        "id": 2,
        "url": "http://localhost:8000/api/v3/users/2"
    },
    "entity_type": "post",
    "fields": null,
    "filters": {
        "status": [
            "all"
        ]
    },
    "status": "PENDING",
    "header_row": null,
    "created": "2022-11-02T15:42:55+00:00",
    "updated": null,
    "url_expiration": 0,
    "include_hxl": false,
    "send_to_browser": true,
    "send_to_hdx": false,
    "hxl_heading_row": null,
    "hxl_meta_data_id": null,
    "total_batches": null,
    "total_rows": null,
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
    ]
}
```

{% endtab %}
{% endtabs %}

## edit export

<mark style="color:orange;">`PUT`</mark> `https://ushahididocs.api.ushahidi.io/api/v3/exports/jobs/1`

#### Request Body

| Name                | Type    | Description                                          |
| ------------------- | ------- | ---------------------------------------------------- |
| user\_id            | String  | The user identifier                                  |
| url\_expiration     | Integer |                                                      |
| updated             | String  |                                                      |
| header\_row         | String  |                                                      |
| status              | String  |                                                      |
| filters             | String  |                                                      |
| fields              | String  |                                                      |
| entity\_type        | String  | The entity types                                     |
| hxl\_heading\_row   | String  |                                                      |
| send\_to\_hdx       | String  | Set true to send HXL and false not to send HXL       |
| send\_to\_browser   | String  |                                                      |
| include\_hxl        | Boolean | Set true to include HXL and false not to include HXL |
| total\_rows         | String  |                                                      |
| total\_batches      | String  |                                                      |
| hxl\_meta\_data\_id | String  |                                                      |

{% tabs %}
{% tab title="200: OK " %}

```javascript
{
    "id": 9,
    "url": null,
    "user": {
        "id": 2,
        "url": "http://localhost:8000/api/v3/users/2"
    },
    "entity_type": "post",
    "fields": null,
    "filters": {
        "status": [
            "all"
        ]
    },
    "status": "PENDING",
    "header_row": null,
    "created": "2022-11-02T15:42:55+00:00",
    "updated": null,
    "url_expiration": 0,
    "include_hxl": false,
    "send_to_browser": true,
    "send_to_hdx": false,
    "hxl_heading_row": null,
    "hxl_meta_data_id": null,
    "total_batches": null,
    "total_rows": null,
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
    ]
}
```

{% endtab %}
{% endtabs %}

{% openapi src="<https://content.gitbook.com/content/tXIYKGMTeHub5C8O9fER/blobs/TC8KXqdBoVrA1ZGmo9Kk/UshahidiV3.json>" path="/api/v3/exports/jobs/1" method="get" %}
[UshahidiV3.json](https://content.gitbook.com/content/tXIYKGMTeHub5C8O9fER/blobs/TC8KXqdBoVrA1ZGmo9Kk/UshahidiV3.json)
{% endopenapi %}
