Sepa Export

Download OpenAPI specification:Download

Sepa Export API

Files

Get Sepa Export file by id for tenant

Downloads a specified Sepa Export file.


Required scopes

  • sepaexport.media_view
SecurityOAuth2
Request
path Parameters
tenant
required
string

Your Emporix tenant's name. Note: The tenant should always be written in lowercase.

fileId
required
string

Sepa Export file's unique identifier.

Responses
200

Sepa Export file

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

404

Given resource does not exist.

get/{tenant}/files/{fileId}
Request samples
Response samples
application/json
{
  • "fault": {
    }
}

Jobs

Retrieving a list of export jobs

Retrieves a list of Sepa Export jobs.


Required scopes

  • sepaexport.job_view
SecurityOAuth2
Request
path Parameters
tenant
required
string

Your Emporix tenant's name. Note: The tenant should always be written in lowercase.

query Parameters
siteCode
required
string

Site code, defined when a site is created.

pageNumber
integer <int32> >= 1
Default: 1

Page number to be retrieved. The number of the first page is 1. Note: If the pageNumber parameter is passed, size of the pages must be specified in the pageSize parameter.

pageSize
integer <int32> >= 1
Default: 16

Number of export files to be retrieved per page.

sort
string
Default: "DESC"

List of properties used to sort the results, separated by commas. Possible values:

  • ASC
  • DESC
Enum: "ASC" "DESC"
Responses
200

List of jobs

400

Request syntactically incorrect. Any details will be provided within the response payload.

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

get/{tenant}/jobs
Request samples
Response samples
application/json
[
  • {
    }
]

Creating a new export job

Creates a new Sepa Export job.


Required scopes

  • sepaexport.job_manage
SecurityOAuth2
Request
path Parameters
tenant
required
string

Your Emporix tenant's name. Note: The tenant should always be written in lowercase.

Request Body schema: application/json

Create new job

siteCode
required
string non-empty
Responses
201

New job id

400

Request syntactically incorrect. Any details will be provided within the response payload.

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

409

Another job is in progress. You can have only one job at the same time.

post/{tenant}/jobs
Request samples
application/json
{
  • "siteCode": "main"
}
Response samples
application/json
{
  • "id": "string"
}