API オブジェクトで宣言されたサービスのメソッドを指定します。

構文

' [ 'RestMethod(<Method>)' ] '

構文の表記規則の表示
入力値の説明:
Method
         実行する操作を指定する HTTP メソッドです。

説明

サービスのメソッドは、既定で GET です。GET を使用したくない場合は、サービスを提供するメソッドを指定するためのこのアノテーションを使用できます。

サンプル

新しい顧客を入力します。
ビジネスコンポーネントとして定義されている次のトランザクションがあるとします。

Customer 
{ 
     CustomerId* (Autonumber property = Yes) 
     CustomerName 
     CustomerLastName 
}

InsertOneCustomer というプロシージャーを作成し、次のように定義します:
変数:

&Customer (Type: Customer) 
&CustomerId (Type:Attribute:CustomerId) 
&CustomerName (Type:Attribute:CustomerName) 
&CustomerLastName (Type:Attribute:CustomerLastName) 
&Messages (Type: Messages, GeneXus.Common)

ルール:

Parm(in:&CustomerId, in:&CustomerName, in:&CustomerLastName, out:&Messages);

ソース:

&Customer.CustomerId = &CustomerId 
&Customer.CustomerName = &CustomerName 
&Customer.CustomerLastName = &CustomerLastName 

if &Customer.Insert() 
   commit 
Else 
   rollback 
Endif 
&Messages = &Customer.GetMessages()

APICustomer という API オブジェクトを作成し、次のように定義します:
変数:

&CustomerId         (Type:Attribute:CustomerId) 
&CustomerName       (Type:Attribute:CustomerName) 
&CustomerLastName   (Type:Attribute:CustomerLastName) 
&Messages           (Type: Messages, GeneXus.Common)

サービスソース:

Customer 
{ 
      [ RestMethod(POST) ]  
     InsertCustomer(in:&CustomerId, in:&CustomerName, in:&CustomerLastName, out:&Messages) =>InsertOneCustomer(&CustomerId,&CustomerName, &CustomerLastName, &Messages); 
}

注:

• RestMethod アノテーションは、RestPath アノテーションと組み合わせることができます。たとえば、次のようにできます: [ RestMethod(PUT),RestPath ("/Customer/{&CustomerId}/{&CustomerName}") ] 。
  
• RestMethod アノテーションは、サービスの宣言の直前に記述する必要があります。
  

使用可能バージョン

GeneXus 17 Upgrade 9 以降。