Configurations

Create fetch configuration

SecurityapiKey
Request
Request Body schema: application/json
required
object (FetchConfigurationModel)
name
required
string (ConfigurationName)

The name of the configuration

Responses
200

Configuration created successfully

400

Bad Request.

post/configurations/businesspartnerfetch
Request samples
application/json
{
  • "name": "Fetch Configuration Production",
  • "configuration": {
    }
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "configuration": {
    },
  • "createdAt": "string",
  • "modifiedAt": "string",
  • "createdBy": "string"
}

Delete fetch configuration

SecurityapiKey
Request
path Parameters
configurationId
required
string
Responses
200

OK.

400

Bad Request.

delete/configurations/businesspartnerfetch/{configurationId}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "name": "string",
  • "configuration": {
    },
  • "createdAt": "string",
  • "modifiedAt": "string",
  • "createdBy": "string"
}
List current user's fetch configuration
SecurityapiKey 
Request 
query Parameters
limit
integer (Limit) 
Number of items per page.


 
 Example:  limit=100
startAfter
string (StartAfter) 
The ID which is used to read the page.


 
 Example:  startAfter=5712566172571652
Responses 
200
Successful operation


get/configurations/businesspartnerfetch
Request samples 
Response samples 
application/json
{
  • "startAfter": "5712566172571652",
  • "nextStartAfter": "5712566172571652",
  • "total": "67",
  • "values": [
    ]
}
Read current user’s fetch configuration
SecurityapiKey 
Request 
path Parameters
configurationId
required
string
 
Responses 
200
Successful operation


get/configurations/businesspartnerfetch/{configurationId}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "name": "string",
  • "configuration": {
    },
  • "createdAt": "string",
  • "modifiedAt": "string",
  • "createdBy": "string"
}
Update fetch configuration
SecurityapiKey 
Request 
path Parameters
configurationId
required
string
 
Request Body schema: application/json
object (FetchConfigurationModel) 
 
name
string (ConfigurationName) 
The name of the configuration


 
Responses 
200
Configuration updated successful


400
Bad Request.


put/configurations/businesspartnerfetch/{configurationId}
Request samples 
application/json
{
  • "name": "Fetch Configuration Production",
  • "configuration": {
    }
}
Response samples 
application/json
{
  • "id": "string",
  • "name": "string",
  • "configuration": {
    },
  • "createdAt": "string",
  • "modifiedAt": "string",
  • "createdBy": "string"
}