Backend_Operation

struct

This object represents an operation, an operation invokes an action in case a specific HTTP method and path was requested. It defines also schema information about the request and response payload

Property	Type	Description
kind	String	Uniquely identifies the object schema type
id	Integer	Unique identifier for the object
status	Integer	Status of the object either 1 = active or 0 = deleted
active	Boolean	Indicates whether the operation is active
public	Boolean	Indicates whether the operation is public, if false a user must provide an Authorization header with an Bearer access token
stability	Integer	Describes the stability of this operation 0 = deprecated, 1 = experimental, 2 = stable and 3 = legacy
description	String	A short description of this operation, it should explain the operation in a simple and precise way
httpMethod	String	The target HTTP method i.e. GET or POST
httpPath	String	The target HTTP path i.e. /foo or /product/:product_id
httpCode	Integer	The success HTTP code i.e. 200 or 201
name	String	Unique name of the object. It is recommended to group your operations into logical units by using a dot i.e. product.getAll and product.insert which has also an effect on the automatically generated SDK
parameters	Backend_OperationParameters	Describes available query parameters
incoming	String	Describes the incoming request payload, this must contain a schema name
outgoing	String	Describes the outgoing response payload, this must contain a schema name
throws	Backend_OperationThrows	Describes error responses for i.e. client or server errors
action	String	The target action to invoke, this must contain an action name
costs	Integer	Costs to invoke this operation. A user can only invoke this operation in case he has enough points
scopes	ArrayString	Scopes which are required to invoke this operation
metadata	Common_Metadata	Use this parameter to attach key-value data