Exports

get exports

GEThttps://ushahididocs.api.ushahidi.io/api/v3/exports/jobs

Query parameters

Response

200401

OK

Body

application/json

count*integer (int32)

results*array of getexports_results (object)

limit*nullable string

offset*integer (int32)

order*string

orderby*string

curr*string

next*string

prev*string

total_count*integer (int32)

Request

JavaScriptCurlPython

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/exports/jobs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "results": [
    {
      "url": "text",
      "user": "{\"id\":1,\"url\":\"http://localhost:8000/api/v3/users/1\"}",
      "entity_type": "text",
      "fields": "text",
      "filters": {
        "status": [
          "text"
        ]
      },
      "status": "text",
      "header_row": {
        "label": "text",
        "key": "text",
        "type": "text",
        "input": "text",
        "unstructured": false,
        "id": "text",
        "instructions": "text",
        "required": "text",
        "default": "text",
        "options": "text",
        "cardinality": "text",
        "config": "text",
        "response_private": "text",
        "description": "text",
        "form_name": "text"
      },
      "created": "text",
      "updated": "text",
      "include_hxl": false,
      "send_to_browser": false,
      "send_to_hdx": false,
      "hxl_heading_row": [
        "text"
      ],
      "total_batches": "text",
      "total_rows": "text",
      "allowed_privileges": [
        "text"
      ]
    }
  ],
  "limit": "text",
  "order": "text",
  "orderby": "text",
  "curr": "text",
  "next": "text",
  "prev": "text"
}

add export

POST 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

200: OK

{
    "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"
    ]
}

edit export

PUT 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

200: OK

{
    "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"
    ]
}

get export

GEThttps://ushahididocs.api.ushahidi.io/api/v3/exports/jobs/1

Response

200401404

OK

Body

application/json

id*integer (int32)

url*nullable string

user*createsavedsearch_user (object)

Example: "{\"id\":1,\"url\":\"http://localhost:8000/api/v3/users/1\"}"

entity_type*string

fields*nullable string

filters*nullable string

status*nullable string

header_row*nullable string

created*string

updated*nullable string

url_expiration*integer (int32)

include_hxl*boolean

send_to_browser*boolean

send_to_hdx*boolean

hxl_heading_row*nullable string

hxl_meta_data_id*integer (int32)

total_batches*nullable string

total_rows*nullable string

allowed_privileges*array of string

Request

JavaScriptCurlPython

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/exports/jobs/1', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "id": 1,
  "user": {
    "id": 2,
    "url": "http://localhost:8000/api/v3/users/2"
  },
  "entity_type": "post",
  "created": "1970-01-01T00:00:00+00:00",
  "url_expiration": 0,
  "include_hxl": false,
  "send_to_browser": false,
  "send_to_hdx": false,
  "hxl_meta_data_id": 1,
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search"
  ]
}