Export

An export.

Get all exports

Get all exports of the authenticated user of the authenticated hub.

SecurityJWT
Request
query Parameters
measure
string or integer

Filter the export list for a measure.

measure_package
string or integer

Filter the export list for a measure package.

project
string or integer

Filter the export list for a project.

program
string or integer

Filter the export list for a program.

budgeting
string or integer

Filter the export list for a budgeting.

type
integer

The type of the export.

  • 1 - Profile
  • 2 - Process
  • 3 - Schedule
  • 4 - Effects
  • 5 - Status
  • 6 - User
Enum: 1 2 3 4 5 6
created_user
string or integer

Filter the export list for a created user.

latest
integer [ 1 .. 100 ]

Filter the export list for the latest entries.

The integer value determines the number of elements displayed. The list is sorted in descending order, i.e., the newest element is at the top.

page
integer
Default: 1

The page number of the response.

Responses
200

Successful operation

get/export
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "9315636dde45ca3d59527b5f40050d09659b7518",
  • "data": [
    ],
  • "meta": {
    },
  • "timestamp": 1664896537988
}

Get an export

Get an export.

Returns either the export object or the binary file content, depending on the API server endpoint.

SecurityJWT
Request
path Parameters
export
required
string or integer

The id/hash of the export.

query Parameters
disposition
string
Default: "attachment"

The content-disposition for the requested file.

Only applicable when downloading a file from the Storage API. For attachment the file should be downloaded, forinline the file can be displayed.

Enum: "attachment" "inline"
Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

get/export/{export}
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "9315636dde45ca3d59527b5f40050d09659b7518",
  • "data": {
    },
  • "timestamp": 1664896537988
}

Delete an export

Delete an export.

SecurityJWT
Request
path Parameters
export
required
string or integer

The id/hash of the export.

Responses
200

Successful operation

404

Not Found

delete/export/{export}
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1664900175170
}