• maintenance-controller
  • getretrieveTenantsInMaintenance
  • putunSetMaintenance
  • putsetMaintenance
• module-manager-controller
  • getexportConfiguration
  • postimportConfiguration
  • getisConfigurationEnabled
  • getisReady
  • getisReadyEnabled
  • getrestart
  • getisRestartEnabled
• basket-controller
  • delempty
  • getget
  • delremoveDatasetSelection
  • putupdateFileFilters
  • putattachProcessDescriptionToDatasetSelection
  • delremoveDatedItemsSelection
  • postaddSelection
• order-controller
  • postcreateAppOrder
  • postgenerateCsv
  • postfindAllAdmin
  • getfindAll
  • postcreateOrder
  • postCreate an order automatically from a OrderRequestDto.
  • getpublicDownloadMetalinkFile
  • putpauseOrder
  • delremoveOrder
  • putresumeOrder
  • deldeleteOrder
  • getRetrieve specified order
  • getdownloadAllAvailableFiles
  • getdownloadMetalinkFile
  • postrestartOrder
  • putretryOrder
• order-data-file-controller
  • getdownloadFile
  • getpublicDownloadFile
  • headtestDownloadFile
  • getfindFiles
• order-data-file-available-controller
  • getGet files available in specific order
  • getGet files available in specific suborder
• jpa-multitenant-controller
  • getgetDataSourceStatus
  • gettestTenantConnection
• security-resources-controller
  • getgetAllResources
• dynamic-tenant-setting-controller
  • getretrieveAll
  • delreset
  • putupdate
• manager-controller
  • postimmediateShutdown

API docs by Redocly

MICROSERVICE ORDER (1.14.1)

Download OpenAPI specification:Download

License: GPL-3.0

Order API

maintenance-controller

retrieveTenantsInMaintenance

Generated server url

/api/v1/rs-order/maintenance

Authorizations:

REGARDS_OAUTH2

Responses

unSetMaintenance

Generated server url

/api/v1/rs-order/maintenance/{tenant}/disable

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

setMaintenance

Generated server url

/api/v1/rs-order/maintenance/{tenant}/enable

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

module-manager-controller

exportConfiguration

Generated server url

/api/v1/rs-order/microservice/configuration

Authorizations:

REGARDS_OAUTH2

Responses

importConfiguration

Generated server url

/api/v1/rs-order/microservice/configuration

Authorizations:

REGARDS_OAUTH2

Request Body schema: multipart/form-data

file required

string <binary>

Responses

isConfigurationEnabled

Generated server url

/api/v1/rs-order/microservice/configuration/enabled

Authorizations:

REGARDS_OAUTH2

Responses

isReady

Generated server url

/api/v1/rs-order/microservice/ready

Authorizations:

REGARDS_OAUTH2

Responses

isReadyEnabled

Generated server url

/api/v1/rs-order/microservice/ready/enabled

Authorizations:

REGARDS_OAUTH2

Responses

restart

Generated server url

/api/v1/rs-order/microservice/restart

Authorizations:

REGARDS_OAUTH2

Responses

isRestartEnabled

Generated server url

/api/v1/rs-order/microservice/restart/enabled

Authorizations:

REGARDS_OAUTH2

Responses

basket-controller

empty

Generated server url

/api/v1/rs-order/order/basket

Authorizations:

REGARDS_OAUTH2

Responses

get

Generated server url

/api/v1/rs-order/order/basket

Authorizations:

REGARDS_OAUTH2

Responses

removeDatasetSelection

Generated server url

/api/v1/rs-order/order/basket/dataset/{datasetSelectionId}

Authorizations:

REGARDS_OAUTH2

path Parameters

datasetSelectionId required

integer <int64>

Responses

updateFileFilters

Generated server url

/api/v1/rs-order/order/basket/dataset/{datasetSelectionId}/updateFileFilters

Authorizations:

REGARDS_OAUTH2

path Parameters

datasetSelectionId required

integer <int64>

Request Body schema: application/json

fileNamePattern	string
fileTypes	Array of strings unique Items Enum: "RAWDATA" "QUICKLOOK"

Responses

Request samples

• Payload

Content type

application/json

{

• "fileNamePattern": "string",
• "fileTypes": [

  • "RAWDATA"

  ]

}

attachProcessDescriptionToDatasetSelection

Generated server url

/api/v1/rs-order/order/basket/dataset/{datasetSelectionId}/updateProcessing

Authorizations:

REGARDS_OAUTH2

path Parameters

datasetSelectionId required

integer <int64>

Request Body schema: application/json

	object
processBusinessId	string <uuid>

Responses

Request samples

• Payload

Content type

application/json

{

• "parameters": {

  • "property1": "string",
  • "property2": "string"

  },
• "processBusinessId": "f2660539-8277-4c23-b670-4eb877b20724"

}

removeDatedItemsSelection

Generated server url

/api/v1/rs-order/order/basket/dataset/{datasetSelectionId}/{itemsSelectionDate}

Authorizations:

REGARDS_OAUTH2

path Parameters

datasetSelectionId required	integer <int64>
itemsSelectionDate required	string

Responses

addSelection

Generated server url

/api/v1/rs-order/order/basket/selection

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

datasetUrn	string
engineType required	string
entityIdsToExclude	Array of strings unique
entityIdsToInclude	Array of strings unique
	object
selectionDate	string <date-time>

Responses

Request samples

• Payload

Content type

application/json

{

• "datasetUrn": "string",
• "engineType": "string",
• "entityIdsToExclude": [

  • "string"

  ],
• "entityIdsToInclude": [

  • "string"

  ],
• "searchParameters": {

  • "all": {

    • "property1": "string",
    • "property2": "string"

    },
  • "empty": true,
  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "selectionDate": "2019-08-24T14:15:22Z"

}

order-controller

createAppOrder

Generated server url

/api/v1/rs-order/orders

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

label	string
onSuccessUrl	string

Responses

Request samples

• Payload

Content type

application/json

{

• "label": "string",
• "onSuccessUrl": "string"

}

generateCsv

Generated server url

/api/v1/rs-order/orders/csv

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

	object (DatesRangeRestriction) Filter on creation date
owner	string Filter on owner
	object (ValuesRestrictionOrderStatus) Filter on status of request
waitingForUser	boolean Filter on waiting for user

Responses

Request samples

• Payload

Content type

application/json

{

• "creationDate": {

  • "after": "2019-08-24T14:15:22Z",
  • "before": "2019-08-24T14:15:22Z"

  },
• "owner": "string",
• "statuses": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • "PENDING"

    ]

  },
• "waitingForUser": true

}

findAllAdmin

Generated server url

/api/v1/rs-order/orders/search

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

	object (SearchRequestParameters)
	object (Pageable)

Responses

Request samples

• Payload

Content type

application/json

{

• "filters": {

  • "creationDate": {

    • "after": "2019-08-24T14:15:22Z",
    • "before": "2019-08-24T14:15:22Z"

    },
  • "owner": "string",
  • "statuses": {

    • "ignoreCase": true,
    • "matchMode": "STRICT",
    • "mode": "INCLUDE",
    • "values": [

      • "PENDING"

      ]

    },
  • "waitingForUser": true

  },
• "pageRequest": {

  • "page": 0,
  • "size": 1,
  • "sort": [

    • "string"

    ]

  }

}

findAll

Generated server url

/api/v1/rs-order/user/orders

Authorizations:

REGARDS_OAUTH2

query Parameters

required

object (Pageable)

Responses

createOrder

Generated server url

/api/v1/rs-order/user/orders

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

label	string
onSuccessUrl	string

Responses

Request samples

• Payload

Content type

application/json

{

• "label": "string",
• "onSuccessUrl": "string"

}

Create an order automatically from a OrderRequestDto.

Generated server url

/api/v1/rs-order/user/orders/apply

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

OrderRequestDto to create an order.

correlationId	string [ 0 .. 255 ] characters
	object (OrderRequestFilters)
queries required	Array of strings
sizeLimitInBytes	integer <int64>
user	string [ 0 .. 128 ] characters

Responses

Request samples

• Payload

Content type

application/json

{

• "correlationId": "string",
• "filters": {

  • "dataTypes": [

    • "RAWDATA"

    ],
  • "filenameRegExp": "string"

  },
• "queries": [

  • "string"

  ],
• "sizeLimitInBytes": 0,
• "user": "string"

}

publicDownloadMetalinkFile

Generated server url

/api/v1/rs-order/user/orders/metalink/download

Authorizations:

REGARDS_OAUTH2

query Parameters

orderToken required

string

Responses

pauseOrder

Generated server url

/api/v1/rs-order/user/orders/pause/`{orderId}`

Authorizations:

REGARDS_OAUTH2

path Parameters

orderId required

integer <int64>

Responses

removeOrder

Generated server url

/api/v1/rs-order/user/orders/remove/`{orderId}`

Authorizations:

REGARDS_OAUTH2

path Parameters

orderId required

integer <int64>

Responses

resumeOrder

Generated server url

/api/v1/rs-order/user/orders/resume/`{orderId}`

Authorizations:

REGARDS_OAUTH2

path Parameters

orderId required

integer <int64>

Responses

deleteOrder

Generated server url

/api/v1/rs-order/user/orders/`{orderId}`

Authorizations:

REGARDS_OAUTH2

path Parameters

orderId required

integer <int64>

Responses

Retrieve specified order

Generated server url

/api/v1/rs-order/user/orders/`{orderId}`

Return order corresponding to the orderId input, if exists and user has access to it

Authorizations:

REGARDS_OAUTH2

path Parameters

orderId required

integer <int64>

Responses

downloadAllAvailableFiles

Generated server url

/api/v1/rs-order/user/orders/`{orderId}`/download

Authorizations:

REGARDS_OAUTH2

path Parameters

orderId required

integer <int64>

Responses

downloadMetalinkFile

Generated server url

/api/v1/rs-order/user/orders/`{orderId}`/metalink/download

Authorizations:

REGARDS_OAUTH2

path Parameters

orderId required

integer <int64>

Responses

restartOrder

Generated server url

/api/v1/rs-order/user/orders/`{orderId}`/restart

Authorizations:

REGARDS_OAUTH2

path Parameters

orderId required

integer <int64>

Request Body schema: application/json

required

label	string
onSuccessUrl	string

Responses

Request samples

• Payload

Content type

application/json

{

• "label": "string",
• "onSuccessUrl": "string"

}

retryOrder

Generated server url

/api/v1/rs-order/user/orders/`{orderId}`/retry

Authorizations:

REGARDS_OAUTH2

path Parameters

orderId required

integer <int64>

Responses

order-data-file-controller

downloadFile

Generated server url

/api/v1/rs-order/orders/files/{dataFileId}

Authorizations:

REGARDS_OAUTH2

path Parameters

dataFileId required

integer <int64>

Responses

publicDownloadFile

Generated server url

/api/v1/rs-order/orders/public/files/{dataFileId}

Authorizations:

REGARDS_OAUTH2

path Parameters

dataFileId required

integer <int64>

query Parameters

orderToken required

string

Responses

testDownloadFile

Generated server url

/api/v1/rs-order/orders/public/files/{dataFileId}

Authorizations:

REGARDS_OAUTH2

path Parameters

dataFileId required

integer <int64>

query Parameters

orderToken required

string

Responses

findFiles

Generated server url

/api/v1/rs-order/orders/`{orderId}`/dataset/{datasetId}/files

Authorizations:

REGARDS_OAUTH2

path Parameters

datasetId required	integer <int64>
orderId required	integer <int64>

query Parameters

required

object (Pageable)

Responses

order-data-file-available-controller

Get files available in specific order

Generated server url

/api/v1/rs-order/orders/`{orderId}`/files/available

Return files corresponding to the orderId input, if exists and user has access to it

Authorizations:

REGARDS_OAUTH2

path Parameters

orderId required

integer <int64>

query Parameters

required

object (Pageable)

Responses

Get files available in specific suborder

Generated server url

/api/v1/rs-order/orders/`{orderId}`/filesTask/{filesTaskId}/files/available

Return files corresponding to the orderId and filesTaskId input, if exists and user has access to it

Authorizations:

REGARDS_OAUTH2

path Parameters

filesTaskId required	integer <int64>
orderId required	integer <int64>

query Parameters

required

object (Pageable)

Responses

jpa-multitenant-controller

getDataSourceStatus

Generated server url

/api/v1/rs-order/regards/{tenant}/datasource/status

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

Response samples

• 200

Content type

application/json;charset=UTF-8

{

• "message": "string",
• "properties": {

  • "property1": { },
  • "property2": { }

  }

}

testTenantConnection

Generated server url

/api/v1/rs-order/regards/{tenant}/datasource/test

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

Response samples

• 200

Content type

application/json;charset=UTF-8

{

• "message": "string",
• "properties": {

  • "property1": { },
  • "property2": { }

  }

}

security-resources-controller

getAllResources

Generated server url

/api/v1/rs-order/security/resources

Authorizations:

REGARDS_OAUTH2

Responses

Response samples

• 200

Content type

application/json

[

• {

  • "autorizedRoles": [

    • {

      • "authority": "string",
      • "authorizedIpAdresses": [

        • "string"

        ],
      • "roleName": "string"

      }

    ],
  • "controllerSimpleName": "string",
  • "fullPath": "string",
  • "method": "GET",
  • "resourceAccess": { },
  • "resourceMappingId": "string"

  }

]

dynamic-tenant-setting-controller

retrieveAll

Generated server url

/api/v1/rs-order/settings

Authorizations:

REGARDS_OAUTH2

query Parameters

names

Array of strings unique

Responses

reset

Generated server url

/api/v1/rs-order/settings/{name}

Authorizations:

REGARDS_OAUTH2

path Parameters

name required

string

Responses

update

Generated server url

/api/v1/rs-order/settings/{name}

Authorizations:

REGARDS_OAUTH2

path Parameters

name required

string

Request Body schema: application/json

required

defaultValue	object
description	string
name	string
value	object

Responses

Request samples

• Payload

Content type

application/json

{

• "defaultValue": { },
• "description": "string",
• "name": "string",
• "value": { }

}

manager-controller

immediateShutdown

Generated server url

/api/v1/rs-order/shutdown/immediate

Authorizations:

REGARDS_OAUTH2

Responses