Class RestOperation

Namespace
ESRI.Server.SOESupport
Assembly
ESRI.Server.SOESupport.dll

A class that represents a REST operation.

public sealed class RestOperation
Inheritance
RestOperation
Inherited Members

Constructors

RestOperation(string, string[], string[], OperationHandler)

Creates a new RestOperation instance.

public RestOperation(string name, string[] parameters, string[] supportedFormats, OperationHandler handler)

Parameters

name string

The name of the operation.

parameters string[]

The parameters for the operation.

supportedFormats string[]

The output formats supported by the operation (e.g. "json").

handler OperationHandler

The operation handler function that should be called when requests for this operation are received.

RestOperation(string, string[], string[], OperationHandler, bool)

Creates a new RestOperation instance.

public RestOperation(string name, string[] parameters, string[] supportedFormats, OperationHandler handler, bool postOnly)

Parameters

name string

The name of the operation.

parameters string[]

The parameters for the operation.

supportedFormats string[]

The output formats supported by the operation (e.g. "json").

handler OperationHandler

The operation handler function that should be called when requests for this operation are received.

postOnly bool

Indicates if the operation should be supported only for HTTP POST requests (not GET).

RestOperation(string, string[], string[], OperationHandler, string)

Creates a new RestOperation instance.

public RestOperation(string name, string[] parameters, string[] supportedFormats, OperationHandler handler, string requiredCapability)

Parameters

name string

The name of the operation.

parameters string[]

The parameters for the operation.

supportedFormats string[]

The output formats supported by the operation (e.g. "json").

handler OperationHandler

The operation handler function that should be called when requests for this operation are received.

requiredCapability string

The capability required in a configuration for an operation to be executable.

RestOperation(string, string[], string[], OperationHandler, string, bool)

Creates a new RestOperation instance.

public RestOperation(string name, string[] parameters, string[] supportedFormats, OperationHandler handler, string requiredCapability, bool postOnly)

Parameters

name string

The name of the operation.

parameters string[]

The parameters for the operation.

supportedFormats string[]

The output formats supported by the operation (e.g. "json").

handler OperationHandler

The operation handler function that should be called when requests for this operation are received.

requiredCapability string

The capability required in a configuration for an operation to be executable.

postOnly bool

Indicates if the operation should be supported only for HTTP POST requests (not GET).

Fields

name

The name of the operation.

public string name

Field Value

string

parameters

The parameters for the operation.

public string[] parameters

Field Value

string[]

postOnly

Indicates if the operation should be supported only for HTTP POST requests (not GET).

public bool postOnly

Field Value

bool

supportedOutputFormats

The output formats supported by an operation (e.g. "json").

public string[] supportedOutputFormats

Field Value

string[]

Properties

RequiredCapability

The capability required in a configuration for an operation to be executable.

public string RequiredCapability { get; set; }

Property Value

string

Methods

ToJsonObject()

Converts the RestOperation to a JsonObject instance.

public JsonObject ToJsonObject()

Returns

JsonObject