PreSaleAction

Retrieves the collection of PreSaleAction resources.

Get the list of the presale actions and their current status

SecurityBearer
Request
query Parameters
page
integer
Default: 1

The collection page number

Responses
200

PreSaleAction collection

get/pre-sale-actions
Request samples 
Response samples 
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}
Creates a new PreSaleAction resource.
Create a new presale action


SecurityBearer 
Request 
Request Body schema: 
required
The new PreSaleAction resource


threshold
required
integer
The value under which the PreSaleAction is triggered.


 
action_type
required
string
What kind of action to trigger, currently only alert_mail is supported.


 Value: "alert_mail"  
required
string
The target used by the action, e.g. in case of alert_email the target must be the email address that will receive the message.


 
enabled
required
boolean
 
pre_sale_uuid
required
string
 
Responses 
201
PreSaleAction resource created


400
Invalid input


422
Unprocessable entity


post/pre-sale-actions
Request samples 
{
  • "threshold": 0,
  • "action_type": "alert_mail",
  • "target": null,
  • "enabled": true,
  • "pre_sale_uuid": "string"
}
Response samples 
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "uuid": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "threshold": 0,
  • "action_type": "alert_mail",
  • "target": "string",
  • "enabled": true,
  • "running": true,
  • "pre_sale_uuid": "string"
}
Retrieves a PreSaleAction resource.
Retrieves a PreSaleAction resource.


SecurityBearer 
Request 
path Parameters
uuid
required
string
 
Responses 
200
PreSaleAction resource


404
Resource not found


get/pre-sale-actions/{uuid}
Request samples 
Response samples 
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "uuid": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "threshold": 0,
  • "action_type": "alert_mail",
  • "target": "string",
  • "enabled": true,
  • "running": true,
  • "pre_sale_uuid": "string"
}
Updates a PreSaleAction resource.
Replaces the PreSaleAction resource.


SecurityBearer 
Request 
path Parameters
uuid
required
string
 
Request Body schema: 
required
The updated PreSaleAction resource


threshold
required
integer
The value under which the PreSaleAction is triggered.


 
action_type
required
string
What kind of action to trigger, currently only alert_mail is supported.


 Value: "alert_mail"  
required
string
The target used by the action, e.g. in case of alert_email the target must be the email address that will receive the message.


 
enabled
required
boolean
 
pre_sale_uuid
required
string
 
Responses 
200
PreSaleAction resource updated


400
Invalid input


404
Resource not found


422
Unprocessable entity


put/pre-sale-actions/{uuid}
Request samples 
{
  • "threshold": 0,
  • "action_type": "alert_mail",
  • "target": null,
  • "enabled": true,
  • "pre_sale_uuid": "string"
}
Response samples 
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "uuid": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "threshold": 0,
  • "action_type": "alert_mail",
  • "target": "string",
  • "enabled": true,
  • "running": true,
  • "pre_sale_uuid": "string"
}
Deletes a PreSaleAction resource.
Removes the PreSaleAction resource.


SecurityBearer 
Request 
path Parameters
uuid
required
string
 
Responses 
204
PreSaleAction resource deleted


404
Resource not found


delete/pre-sale-actions/{uuid}
Request samples